Get transform statistics APIedit
Retrieves usage information for transforms.
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/<transform_id>/_stats
GET _data_frame/transforms/<transform_id>,<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_transformscluster privileges to use this API. The built-indata_frame_transforms_userrole has these privileges. For more information, see Security privileges and Built-in roles.
Descriptionedit
You can get statistics for multiple transforms in a single API
request by using a comma-separated list of identifiers or a wildcard expression.
You can get statistics for all transforms by using _all, by
specifying * as the <transform_id>, or by omitting the
<transform_id>.
Path parametersedit
-
<transform_id> - (string) Optional. Identifier for the transform. It can be a transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.
Query parametersedit
-
from -
(integer) Optional. Skips the specified number of transforms.
The default value is
0. -
size -
(integer) Optional. Specifies the maximum number of transforms
to obtain. The default value is
100.
Response bodyedit
-
transforms -
(array) An array of statistics objects for transforms, which are
sorted by the
idvalue in ascending order.
Examplesedit
The following example skips for the first five 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
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
}
}
]
}