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

Authentication

Authorization: <value>

Elasticsearch APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to Get started with Elasticsearch Serverless.

count number required
datafeeds object[] required

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

Get datafeed stats

Required authorization

Authentication

Path parameters

Query parameters

Response