Get datafeeds APIedit

Retrieves configuration information for datafeeds.

Requestedit

GET _ml/datafeeds/<feed_id>

GET _ml/datafeeds/<feed_id>,<feed_id>

GET _ml/datafeeds/

GET _ml/datafeeds/_all

Prerequisitesedit

Descriptionedit

You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>.

This API returns a maximum of 10,000 datafeeds.

Path parametersedit

<feed_id>

(Optional, string) Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression.

If you do not specify one of these options, the API returns information about all datafeeds.

Query parametersedit

allow_no_match

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

  • Contains wildcard expressions and there are no datafeeds 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 datafeeds 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.

Response bodyedit

The API returns an array of datafeed resources. For the full list of properties, see create datafeeds API.

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.

Examplesedit

GET _ml/datafeeds/datafeed-high_sum_total_sales

The API returns the following results:

{
  "count" : 1,
  "datafeeds" : [
    {
      "datafeed_id" : "datafeed-high_sum_total_sales",
      "job_id" : "high_sum_total_sales",
      "query_delay" : "93169ms",
      "indices" : [
        "kibana_sample_data_ecommerce"
      ],
      "query" : {
        "bool" : {
          "filter" : [
            {
              "term" : {
                "_index" : "kibana_sample_data_ecommerce"
              }
            }
          ]
        }
      },
      "scroll_size" : 1000,
      "chunking_config" : {
        "mode" : "auto"
      },
      "delayed_data_check_config" : {
        "enabled" : true
      }
    }
  ]
}