Get data stream stats Generally available; Added in 7.9.0

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

All methods and paths for this operation:

GET /_data_stream/_stats

GET /_data_stream/{name}/_stats

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.

    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 are all, open, closed, hidden, or none.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • _shards object Required

      Contains information about shards that attempted to execute the request.

      Hide _shards attributes Show _shards attributes object
      • failed number Required

        The number of shards the operation or search attempted to run on but failed.

      • successful number Required

        The number of shards the operation or search succeeded on.

      • total number Required

        The number of shards the operation or search will run on overall.

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

        • shard number
        • status string
        • primary boolean
      • 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

        Name of the data stream.

      • maximum_timestamp number

        Time unit for milliseconds

      • store_size number | string

        Total size of all shards for the data stream’s backing indices. This parameter is only returned if the human query parameter is true.

        One of:
        number-1 number string-2 string

        Total size of all shards for the data stream’s backing indices. This parameter is only returned if the human query parameter is true.

        Total size of all shards for the data stream’s backing indices. This parameter is only returned if the human query parameter is true.

      • store_size_bytes number Required

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

    • 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

      One of:
      number-1 number string-2 string

      Total size of all shards for the selected data streams. This property is included only if the human query parameter is true

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