New

The executive guide to generative AI

Read more
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get Datafeeds

The get datafeeds API enables you to retrieve configuration information for datafeeds.

Request

GET _xpack/ml/datafeeds/

GET _xpack/ml/datafeeds/<feed_id>

Path Parameters

feed_id
(string) Identifier for the datafeed. This parameter does not support wildcards, but you can specify _all or omit the feed_id to get information about all datafeeds.

Results

The API returns the following information:

datafeeds
(array) An array of datafeed objects. For more information, see Datafeed Resources.

Authorization

You must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API. For more information, see Security Privileges.

Examples

The following example gets configuration information for the datafeed-it-ops-kpi datafeed:

GET _xpack/ml/datafeeds/datafeed-it-ops-kpi

The API returns the following results:

{
  "count": 1,
  "datafeeds": [
    {
      "datafeed_id": "datafeed-it-ops-kpi",
      "job_id": "it-ops-kpi",
      "query_delay": "60s",
      "frequency": "150s",
      "indices": [
        "it_ops_metrics"
      ],
      "types": [
        "kpi",
        "network",
        "sql"
      ],
      "query": {
        "match_all": {
          "boost": 1
        }
      },
      "scroll_size": 1000,
      "chunking_config": {
        "mode": "auto"
      }
    }
  ]
}
Was this helpful?
Feedback