Get data stream stats Generally available; Added in 7.9.0

GET /_data_stream/{name}/_stats
Api key auth Basic auth Bearer auth

Get statistics for one or more data streams.

Required authorization

  • Index privileges: monitor

Path parameters

  • name string Required

    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 *.

Query parameters

  • expand_wildcards string | array[string]

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

    Values are all, open, closed, hidden, or none.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • _shards object Required
      Hide _shards attributes Show _shards attributes object
      • failed number Required
      • successful number Required
      • total number Required
      • failures array[object]
        Hide failures attributes Show failures attributes object
        • index string
        • node string
        • reason object Required

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Hide reason attributes Show reason attributes object
          • type string Required

            The type of error

          • reason string | null

            A human-readable explanation of the error, in English.

            One of:
            string-1 string string-2 string | null
          • stack_trace string

            The server stack trace. Present only if the error_trace=true parameter was sent with the request.

          • caused_by object

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          • root_cause array[object]

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          • suppressed array[object]

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

            Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • shard number Required
        • status string
      • skipped number
    • 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 array[object] Required

      Contains statistics for the selected data streams.

      Hide data_streams attributes Show data_streams attributes object
      • backing_indices number Required

        Current number of backing indices for the data stream.

      • data_stream string Required
      • maximum_timestamp number

        Time unit for milliseconds

      • store_size number | string

        One of:
        number-1 number string-2 string
      • store_size_bytes number Required

        Total size, in bytes, of all shards for the data stream’s backing indices.

    • total_store_sizes number | string

      One of:
      number-1 number string-2 string
    • total_store_size_bytes number Required

      Total size, in bytes, of all shards for the selected data streams.
GET /_data_stream/{name}/_stats 
GET /_data_stream/my-index-000001/_stats 
resp = client.indices.data_streams_stats( name="my-index-000001", )
const response = await client.indices.dataStreamsStats({ name: "my-index-000001", });
response = client.indices.data_streams_stats( name: "my-index-000001" )
$resp = $client->indices()->dataStreamsStats([ "name" => "my-index-000001", ]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_data_stream/my-index-000001/_stats"
Response examples (200)
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 } ] }