Get data frame transform statistics APIedit

Retrieves usage information for data frame transforms.

Warning

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Requestedit

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

Prerequisitesedit

  • If the Elasticsearch 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 Security privileges and Built-in roles.

Descriptionedit

You can get statistics for multiple data frame transforms in a single API request by using a comma-separated list of identifiers or a wildcard expression. You can get statistics for all data frame transforms by using _all, by specifying * as the <data_frame_transform_id>, or by omitting the <data_frame_transform_id>.

Path parametersedit

<data_frame_transform_id>
(Optional, string) Identifier for the data frame transform. It can be a data frame transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all data frame transforms.

Query parametersedit

allow_no_match

(Optional, boolean) Specifies what to do when the request:

  • Contains wildcard expressions and there are no data frame transforms 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 transforms 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.

from
(Optional, integer) Skips the specified number of data frame transforms. The default value is 0.
size
(Optional, integer) Specifies the maximum number of data frame transforms to obtain. The default value is 100.

Response bodyedit

transforms
(array) An array of statistics objects for data frame transforms, which are sorted by the id value in ascending order.

Response codesedit

404 (Missing resources)
If allow_no_match is false, this code indicates that there are no resources that match the request or only partial matches for the request.

Examplesedit

The following example skips for the first five data frame transforms and gets usage information for a maximum of ten results:

GET _data_frame/transforms/_stats?from=5&size=10

The following example gets usage information for the ecommerce_transform data frame transform:

GET _data_frame/transforms/ecommerce_transform/_stats

The API returns the following results:

{
  "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
      }
    }
  ]
}