Get datafeed stats

GET /_ml/datafeeds/{datafeed_id}/_stats
GET /_ml/datafeeds/_stats

You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>. If the datafeed is stopped, the only information you receive is the datafeed_id and the state. This API returns a maximum of 10,000 datafeeds.

Required authorization

Cluster privileges: monitor_ml

Path Parameters

datafeed_id union Id | [] Id optional

Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds.

Leave it out to use /_ml/datafeeds/_stats.

Query Parameters

allow_no_match boolean

Specifies what to do when the request:

Contains wildcard expressions and there are no datafeeds that match.
Contains the _all string or no identifiers and there are no matches.
Contains wildcard expressions and there are only partial matches.

The default value is true, which returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _ml/datafeeds/datafeed-high_sum_total_sales/_stats

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.getDatafeedStats({
  datafeed_id: "datafeed-high_sum_total_sales",
});

Python Elasticsearch Python Client

resp = client.ml.get_datafeed_stats(
    datafeed_id="datafeed-high_sum_total_sales",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_ml/datafeeds/datafeed-high_sum_total_sales/_stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().getDatafeedStats(g -> g
    .datafeedId("datafeed-high_sum_total_sales")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .GetDatafeedStatsAsync(d1 => d1
        .DatafeedId(new[] { "datafeed-high_sum_total_sales" })
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->getDatafeedStats([
    "datafeed_id" => "datafeed-high_sum_total_sales",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.get_datafeed_stats(
  datafeed_id: "datafeed-high_sum_total_sales"
)

Response

No example