WARNING: Version 5.4 of the Elastic Stack has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Get Datafeeds
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
Get Datafeeds
editThe get datafeeds API enables you to retrieve configuration information for datafeeds.
Path Parameters
edit-
feed_id -
(string) Identifier for the datafeed.
This parameter does not support wildcards, but you can specify
_allor omit thefeed_idto get information about all datafeeds.
Results
editThe API returns the following information:
-
datafeeds - (array) An array of datafeed objects. For more information, see Datafeed Resources.
Authorization
editYou must have monitor_ml, monitor, manage_ml, or manage cluster
privileges to use this API. For more information, see Cluster Privileges.
Examples
editThe 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",
"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"
}
}
]
}