Get data stream stats

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

Get statistics for one or more data streams.

Required authorization

Index privileges: monitor

Path Parameters

name union IndexName | [] IndexName optional

Comma-separated list of data streams used to limit the request. Wildcard expressions (*) are supported. To target all data streams in a cluster, omit this parameter or use *.

Leave it out to use /_data_stream/_stats.

Query Parameters

expand_wildcards string ExpandWildcards · default: open,closed

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

Supported values include:

all: Match any data stream or index, including hidden ones.
open: Match open, non-hidden indices. Also matches any non-hidden data stream.
closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

Response

application/json

Examples

A successful response for retrieving statistics for a data stream.

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

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