Get searchable snapshot statistics

Auth

Required privileges

index union string | string[] optional

A comma-separated list of data streams and indices to retrieve statistics for.

Leave it out to use /_searchable_snapshots/stats.

level enum · default: indices: Return stats aggregated at cluster, index or shard level; Values: cluster indices shards

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /my-index/_searchable_snapshots/stats

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X GET "$ELASTICSEARCH_URL/my-index/_searchable_snapshots/stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.searchableSnapshots().stats(s -> s
    .index("my-index")
);

C# Elasticsearch .NET Client

var response = await client.SearchableSnapshots
    .StatsAsync(d1 => d1
        .Indices(new[] { "my-index" })
    );

PHP Elasticsearch PHP Client

$resp = $client->searchableSnapshots()->stats([
    "index" => "my-index",
]);

Ruby Elasticsearch Ruby Client

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

Response

{
  "stats": {},
  "total": {}
}

Generated from the API spec