Get data frame analytics jobs APIedit

Retrieves configuration information for data frame analytics jobs.

This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.


GET _ml/data_frame/analytics/<data_frame_analytics_id>

GET _ml/data_frame/analytics/<data_frame_analytics_id>,<data_frame_analytics_id>

GET _ml/data_frame/analytics/

GET _ml/data_frame/analytics/_all



You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.

Path parametersedit

(Optional, string) Identifier for the data frame analytics job. If you do not specify one of these options, the API returns information for the first hundred data frame analytics jobs. You can get information for all data frame analytics jobs by using _all, by specifying * as the <data_frame_analytics_id>, or by omitting the <data_frame_analytics_id>.

Query parametersedit


(Optional, boolean) Specifies what to do when the request:

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

The default value is true, which 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.

(Optional, integer) Skips the specified number of data frame analytics jobs. The default value is 0.
(Optional, integer) Specifies the maximum number of data frame analytics jobs to obtain. The default value is 100.

Response bodyedit

(array) An array of data frame analytics job resources. For more information, see Data frame analytics job resources.

Response codesedit

404 (Missing resources)
If allow_no_match is false, this code indicates that there are no resources that match the request or only partial matches for the request.


The following example gets configuration information for the loganalytics data frame analytics job:

GET _ml/data_frame/analytics/loganalytics

The API returns the following results:

    "count": 1,
    "data_frame_analytics": [
            "id": "loganalytics",
            "source": {
                "index": "logdata",
                "query": {
                    "match_all": {}
            "dest": {
                "index": "logdata_out",
                "results_field": "ml"
            "analysis": {
                "outlier_detection": {}
            "model_memory_limit": "1gb",
            "create_time": 1562265491319,
            "version" : "8.0.0"