Get datafeed stats

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

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 privileges

Cluster privileges monitor_ml

Path parameters

datafeed_id union string | string[] 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:

  1. Contains wildcard expressions and there are no datafeeds that match.
  2. Contains the _all string or no identifiers and there are no matches.
  3. 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
count number required
datafeeds object[] required
assignment_explanation string

For started datafeeds only, contains messages relating to the selection of a node.

datafeed_id string required

A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.

state enum required

The status of the datafeed, which can be one of the following values: starting, started, stopping, stopped.

Values: started stopped starting stopping
timing_stats object

An object that provides statistical information about timing aspect of this datafeed.

bucket_count number required

The number of buckets processed.

exponential_average_search_time_per_hour_ms number required

The exponential average search time per hour, in milliseconds.

exponential_average_calculation_context object
incremental_metric_value_ms number required
latest_timestamp number
previous_exponential_average_ms number
job_id string required

Identifier for the anomaly detection job.

search_count number required

The number of searches run by the datafeed.

total_search_time_ms number required

The total time the datafeed spent searching, in milliseconds.

average_search_time_per_bucket_ms number

The average search time per bucket, in milliseconds.

running_state object

An object containing the running state for this datafeed. It is only provided if the datafeed is started.

real_time_configured boolean required

Indicates if the datafeed is "real-time"; meaning that the datafeed has no configured end time.

real_time_running boolean required

Indicates whether the datafeed has finished running on the available past data. For datafeeds without a configured end time, this means that the datafeed is now running on "real-time" data.

search_interval object

Provides the latest time interval the datafeed has searched.

end string

The end time.

end_ms number required

The end time as an epoch in milliseconds.

start string

The start time.

start_ms number required

The start time as an epoch in milliseconds.