Get transform stats

GET /_transform/{transform_id}/_stats

Auth

Get usage information for transforms.

Required privileges

Index privileges read view_index_metadata
Cluster privileges monitor_transform

Path parameters

transform_id union string | string[] required: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using _all, by specifying * as the <transform_id>, or by omitting the <transform_id>.

Query parameters

allow_no_match boolean · default: true

Specifies what to do when the request:

Contains wildcard expressions and there are no transforms that match.
Contains the _all string or no identifiers and there are no matches.
Contains wildcard expressions and there are only partial matches.

If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

from number · default: 0

Skips the specified number of transforms.

size number · default: 100

Specifies the maximum number of transforms to obtain.

timeout union oneOf · default: 30s

Controls the time to wait for the stats

Values: -1 0

Response

application/json

count number required
transforms object[] required

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _transform/ecommerce-customer-transform/_stats

JavaScript Elasticsearch JavaScript Client

const response = await client.transform.getTransformStats({
  transform_id: "ecommerce-customer-transform",
});

Python Elasticsearch Python Client

resp = client.transform.get_transform_stats(
    transform_id="ecommerce-customer-transform",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_transform/ecommerce-customer-transform/_stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.transform().getTransformStats(g -> g
    .transformId("ecommerce-customer-transform")
);

C# Elasticsearch .NET Client

var response = await client.TransformManagement.GetTransformStatsAsync(transformId: new[] { "ecommerce-customer-transform" });

PHP Elasticsearch PHP Client

$resp = $client->transform()->getTransformStats([
    "transform_id" => "ecommerce-customer-transform",
]);

Ruby Elasticsearch Ruby Client

response = client.transform.get_transform_stats(
  transform_id: "ecommerce-customer-transform"
)

Response

A successful response that contains usage information for a transform.

{
  "count": 1,
  "transforms": [
    {
      "id": "ecommerce-customer-transform",
      "state": "started",
      "node": {
        "id": "cpTIGMsVQ8Gqwqlxxxxxxx",
        "name": "my.home",
        "ephemeral_id": "5-L21nFsQxxxxxxxxxx-xx",
        "transport_address": "127.0.0.1:9300",
        "attributes": {}
      },
      "stats": {
        "pages_processed": 78,
        "documents_processed": 6027,
        "documents_indexed": 68,
        "documents_deleted": 22,
        "delete_time_in_ms": 214,
        "trigger_count": 168,
        "index_time_in_ms": 412,
        "index_total": 20,
        "index_failures": 0,
        "search_time_in_ms": 353,
        "search_total": 78,
        "search_failures": 0,
        "processing_time_in_ms": 8,
        "processing_total": 78,
        "exponential_avg_checkpoint_duration_ms": 97.30637923893185,
        "exponential_avg_documents_indexed": 2.2064915040974062,
        "exponential_avg_documents_processed": 179.89419945785045
      },
      "checkpointing": {
        "last": {
          "checkpoint": 20,
          "timestamp_millis": 1585344558220,
          "time_upper_bound_millis": 1585344498220
        },
        "changes_last_detected_at": 1585344558219
      },
      "health": {
        "status": "green"
      }
    }
  ]
}