Get Datafeed Statistics

The get datafeed statistics API enables you to retrieve usage information for datafeeds.

Request

GET _xpack/ml/datafeeds/_stats

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

Description

If the datafeed is stopped, the only information you receive is the datafeed_id and the state.

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 count objects. For more information, see the section called “Datafeed Counts”.

Authorization

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

Examples

The 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": ""
    }
  ]
}