CAT Count API

Introduced 1.0

The CAT count operation lists the number of documents in your cluster.

The count includes only live documents. Documents that you deleted are not counted, even if they have not yet been removed from disk by a segment merge. To see the number of deleted documents in each index, use the CAT Indices API.

Endpoints

GET /_cat/count
GET /_cat/count/{index}

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Example requests

GET /_cat/count?v

response = client.cat.count(
  params = { "v": "true" }
)

To see the number of documents in a specific index or alias, add the index or alias name after your query:

GET /_cat/count/<index_or_alias>?v

response = client.cat.count(
  index = "<index_or_alias>",
  params = { "v": "true" }
)

If you want to get information for more than one index or alias, separate the index or alias names with commas:

GET /_cat/count/index_or_alias_1,index_or_alias_2,index_or_alias_3

response = client.cat.count(
  index = "index_or_alias_1,index_or_alias_2,index_or_alias_3"
)

Example response

The following response shows the overall document count as 1625:

epoch      | timestamp | count
1624237738 | 01:08:58  | 1625

Required permissions

If you use the Security plugin, make sure you have the appropriate permissions: indices:data/read/search.