OpenSearch/docs/reference/data-frames/apis/get-transform-stats.asciidoc

[role="xpack"]
[testenv="basic"]
[[get-data-frame-transform-stats]]
=== Get {dataframe-transform} statistics API

[subs="attributes"]
++++
<titleabbrev>Get {dataframe-transform} statistics</titleabbrev>
++++

beta[]

Retrieves usage information for {dataframe-transforms}.


==== Request


`GET _data_frame/transforms/<data_frame_transform_id>/_stats`

`GET _data_frame/transforms/<data_frame_transform_id>,<data_frame_transform_id>/_stats` +

`GET _data_frame/transforms/_stats` +

`GET _data_frame/transforms/_all/_stats` +

`GET _data_frame/transforms/*/_stats` +

//===== Description

==== Path Parameters

`data_frame_transform_id`::
  (string) Identifier for the {dataframe-transform}. It can be a
  {dataframe-transform} identifier or a wildcard expression. If you do not
  specify one of these options, the API returns information for all
  {dataframe-transforms}.


==== Results

The API returns the following information:

`transforms`::
  (array) An array of statistics objects for {dataframe-transforms}.

==== Authorization

If the {es} {security-features} are enabled, you must have
`monitor_data_frame_transforms` cluster privileges to use this API. The built-in
`data_frame_transforms_user` role has these privileges. For more information,
see {stack-ov}/security-privileges.html[Security privileges] and
{stack-ov}/built-in-roles.html[Built-in roles].

==== Examples

The following example gets usage information for the `ecommerce_transform`
{dataframe-transform}:

[source,js]
--------------------------------------------------
GET _data_frame/transforms/ecommerce_transform/_stats
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

The API returns the following results:
[source,js]
----
{
  "count" : 1,
  "transforms" : [
    {
      "id" : "ecommerce_transform",
      "state" : {
        "task_state" : "started",
        "indexer_state" : "started",
        "checkpoint" : 1,
        "progress" : {
          "total_docs" : 1220,
          "docs_remaining" : 0,
          "percent_complete" : 100.0
        }
      },
      "stats" : {
        "pages_processed" : 2,
        "documents_processed" : 1220,
        "documents_indexed" : 13,
        "trigger_count" : 1,
        "index_time_in_ms" : 19,
        "index_total" : 1,
        "index_failures" : 0,
        "search_time_in_ms" : 52,
        "search_total" : 2,
        "search_failures" : 0
      },
      "checkpointing" : {
        "current" : {
          "timestamp_millis" : 1557474786393
        },
        "operations_behind" : 0
      }
    }
  ]
}
----
// TESTRESPONSE