Searchable snapshot statistics API

Searchable snapshot statistics API

New API reference

For the most up-to-date API details, refer to Searchable snapshots APIs.

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Retrieves statistics about searchable snapshots.

Request

GET /_searchable_snapshots/stats

GET /<target>/_searchable_snapshots/stats

Prerequisites

If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API. You must also have the manage index privileges for the target data stream or index.

Description

Path parameters

<target>

(Optional, string) Comma-separated list of data streams and indices to retrieve statistics for. To retrieve statistics for all data streams and indices, omit this parameter.

Examples

Retrieves the statistics of the index my-index:

resp = client.searchable_snapshots.stats(
    index="my-index",
)
print(resp)

response = client.searchable_snapshots.stats(
  index: 'my-index'
)
puts response

const response = await client.searchableSnapshots.stats({
  index: "my-index",
});
console.log(response);

GET /my-index/_searchable_snapshots/stats