--
:api: get-data-frame-analytics-stats
:request: GetDataFrameAnalyticsStatsRequest
:response: GetDataFrameAnalyticsStatsResponse
--
[role="xpack"]
[id="{upid}-{api}"]
=== Get {dfanalytics-jobs} stats API

experimental::[]

Retrieves the operational statistics of one or more {dfanalytics-jobs}.
The API accepts a +{request}+ object and returns a +{response}+.

[id="{upid}-{api}-request"]
==== Get {dfanalytics-jobs} stats request

A +{request}+ requires either a {dfanalytics-job} ID, a comma-separated list of
IDs, or the special wildcard `_all` to get the statistics for all
{dfanalytics-jobs}.

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> Constructing a new GET stats request referencing an existing
{dfanalytics-job}

include::../execution.asciidoc[]

[id="{upid}-{api}-response"]
==== Response

The returned +{response}+ contains the requested {dfanalytics-job} statistics.

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------