Get data stream stats

GET /_data_stream/{name}/_stats
GET /_data_stream/_stats

Get statistics for one or more data streams.

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

_shards object required: Contains information about shards that attempted to execute the request.
backing_indices number required: Total number of backing indices for the selected data streams.
data_stream_count number required: Total number of selected data streams.
data_streams object[] required: Contains statistics for the selected data streams.
total_store_sizes number | string: Total size of all shards for the selected data streams. This property is included only if the human query parameter is true
total_store_size_bytes number required: Total size, in bytes, of all shards for the selected data streams.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_data_stream/my-index-000001/_stats

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.dataStreamsStats({
  name: "my-index-000001",
});

Python Elasticsearch Python Client

resp = client.indices.data_streams_stats(
    name="my-index-000001",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_data_stream/my-index-000001/_stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().dataStreamsStats(d -> d
    .name("my-index-000001")
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .DataStreamsStatsAsync(d1 => d1
        .Name(new[] { "my-index-000001" })
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->dataStreamsStats([
    "name" => "my-index-000001",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.data_streams_stats(
  name: "my-index-000001"
)

Response

A successful response for retrieving statistics for a data stream.

{
  "_shards": {
    "total": 10,
    "successful": 5,
    "failed": 0
  },
  "data_stream_count": 2,
  "backing_indices": 5,
  "total_store_size": "7kb",
  "total_store_size_bytes": 7268,
  "data_streams": [
    {
      "data_stream": "my-data-stream",
      "backing_indices": 3,
      "store_size": "3.7kb",
      "store_size_bytes": 3772,
      "maximum_timestamp": 1607512028000
    },
    {
      "data_stream": "my-data-stream-two",
      "backing_indices": 2,
      "store_size": "3.4kb",
      "store_size_bytes": 3496,
      "maximum_timestamp": 1607425567000
    }
  ]
}