OpenSearch/docs/en/rest-api/ml/get-datafeed.asciidoc

//lcawley Verified example output 2017-04-11
[[ml-get-datafeed]]
==== Get Data Feeds

The get data feeds API enables you to retrieve configuration information for
data feeds.

===== Request

`GET _xpack/ml/datafeeds/` +

`GET _xpack/ml/datafeeds/<feed_id>`

===== Description

You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
privileges to use this API. For more information, see <<privileges-list-cluster>>.

//TBD: The get job API can also be applied to all jobs by using `_all` as the job name.

===== Path Parameters

`feed_id`::
  (string) Identifier for the data feed.
  Does not support wildcards, however you may specify `_all` or leave blank to get information about all data feeds.

===== Results

The API returns the following information:

`datafeeds`::
  (array) An array of data feed objects.
  For more information, see <<ml-datafeed-resource,data feed resources>>.

////
===== Responses

200
(EmptyResponse) The cluster has been successfully deleted
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: clusters.cluster_not_found)
412
(BasicFailedReply) The Elasticsearch cluster has not been shutdown yet (code: clusters.cluster_plan_state_error)
////
===== Examples

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

[source,js]
--------------------------------------------------
GET _xpack/ml/datafeeds/datafeed-it-ops-kpi
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

The API returns the following results:
[source,js]
----
{
  "count": 1,
  "datafeeds": [
    {
      "datafeed_id": "datafeed-it-ops-kpi",
      "job_id": "it-ops-kpi",
      "query_delay": "60s",
      "frequency": "150s",
      "indexes": [
        "it_ops_metrics"
      ],
      "types": [
        "kpi",
        "network",
        "sql"
      ],
      "query": {
        "match_all": {
          "boost": 1
        }
      },
      "aggregations": {
        "buckets": {
          "date_histogram": {
            "field": "@timestamp",
            "interval": 30000,
            "offset": 0,
            "order": {
              "_key": "asc"
            },
            "keyed": false,
            "min_doc_count": 0
          },
          "aggregations": {
            "events_per_min": {
              "sum": {
                "field": "events_per_min"
              }
            },
            "@timestamp": {
              "max": {
                "field": "@timestamp"
              }
            }
          }
        }
      },
      "scroll_size": 1000,
      "chunking_config": {
        "mode": "manual",
        "time_span": "30000000ms"
      }
    }
  ]
}
----