Path parameters

• id string Required

  Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.

Query parameters

• allow_no_match boolean

  Specifies what to do when the request:

  1. Contains wildcard expressions and there are no data frame analytics jobs that match.
  2. Contains the _all string or no identifiers and there are no matches.
  3. Contains wildcard expressions and there are only partial matches.

  The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

• from number

  Skips the specified number of data frame analytics jobs.

• size number

  Specifies the maximum number of data frame analytics jobs to obtain.

• verbose boolean

  Defines whether the stats response should be verbose.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • count number Required
  • data_frame_analytics array[object] Required

    An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order.

    Hide data_frame_analytics attributes Show data_frame_analytics attributes object

    • analysis_stats object

      An object containing information about the analysis job.

      Hide analysis_stats attributes Show analysis_stats attributes object

      • classification_stats object

        An object containing information about the classification analysis job.

      • outlier_detection_stats object

        An object containing information about the outlier detection job.

      • regression_stats object

        An object containing information about the regression analysis.

    • assignment_explanation string

      For running jobs only, contains messages relating to the selection of a node to run the job.

    • data_counts object Required

      An object that provides counts for the quantity of documents skipped, used in training, or available for testing.

      Hide data_counts attributes Show data_counts attributes object

      • skipped_docs_count number Required

        The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element.

      • test_docs_count number Required

        The number of documents that are not used for training the model and can be used for testing.

      • training_docs_count number Required

        The number of documents that are used for training the model.

    • id string Required

      The unique identifier of the data frame analytics job.

    • memory_usage object Required

      An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.

      Hide memory_usage attributes Show memory_usage attributes object

      • memory_reestimate_bytes number

        This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs.

      • peak_usage_bytes number Required

        The number of bytes used at the highest peak of memory usage.

      • status string Required

        The memory usage status.

    • progress array[object] Required

      The progress report of the data frame analytics job by phase.

      Hide progress attributes Show progress attributes object

      • phase string Required

        Defines the phase of the data frame analytics job.

      • progress_percent number Required

        The progress that the data frame analytics job has made expressed in percentage.

    • state string Required

      The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.

      Values are started, stopped, starting, stopping, or failed.