IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Cache stats API Clear cache API »
Elastic Docs ›Elasticsearch Guide [8.8] ›REST APIs ›Searchable snapshots APIs

Searchable snapshot statistics API

edit

Searchable snapshot statistics API

edit

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

edit

GET /_searchable_snapshots/stats

GET /<target>/_searchable_snapshots/stats

Prerequisites

edit

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

edit

Path parameters

edit
<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

edit

Retrieves the statistics of the index my-index:

response = client.searchable_snapshots.stats(
  index: 'my-index'
)
puts response
GET /my-index/_searchable_snapshots/stats
« Cache stats API Clear cache API »