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 Datafeed Statistics
editGet Datafeed Statistics
editThe get datafeed statistics API enables you to retrieve usage information for datafeeds.
Description
editIf the datafeed is stopped, the only information you receive is the
datafeed_id
and the state
.
Path Parameters
edit-
feed_id
-
(string) Identifier for the datafeed.
This parameter does not support wildcards, but you can specify
_all
or omit thefeed_id
to get information about all datafeeds.
Results
editThe API returns the following information:
-
datafeeds
- (array) An array of datafeed count objects. For more information, see Datafeed Counts.
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 usage information for the
datafeed-farequote
datafeed:
GET _xpack/ml/datafeeds/datafeed-farequote/_stats
The API returns the following results:
{ "count": 1, "datafeeds": [ { "datafeed_id": "datafeed-farequote", "state": "started", "node": { "id": "IO_gxe2_S8mrzu7OpmK5Jw", "name": "IO_gxe2", "ephemeral_id": "KHMWPZoMToOzSsZY9lDDgQ", "transport_address": "127.0.0.1:9300", "attributes": { "ml.enabled": "true" } }, "assignment_explanation": "" } ] }