Get transform stats

GET /_transform/{transform_id}/_stats

Get usage information for transforms.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

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