New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« cat allocation API cat fielddata API »
Elastic Docs ›Elasticsearch Guide [7.4] ›REST APIs ›cat APIs

cat count API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

cat count API

edit

Provides quick access to a document count of individual indices or all indices in a cluster.

The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

Request

edit

GET /_cat/count/<index>

GET /_cat/count

Path parameters

edit
<index>
(Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.

Query parameters

edit
format
(Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
h
(Optional, string) Comma-separated list of column names to display.
help
(Optional, boolean) If true, the response includes help information. Defaults to false.
s
(Optional, string) Comma-separated list of column names or column aliases used to sort the response.
v
(Optional, boolean) If true, the response includes column headings. Defaults to false.

Examples

edit

Example with an individual index

edit

The following count API request retrieves the document count of a single index, twitter.

GET /_cat/count/twitter?v
Copy as curlTry in Elastic 

The API returns the following response:

epoch      timestamp count
1475868259 15:24:20  120

Example with all indices in a cluster

edit

The following count API request retrieves the document count of all indices in the cluster.

GET /_cat/count?v
Copy as curlTry in Elastic 

The API returns the following response:

epoch      timestamp count
1475868259 15:24:20  121
« cat allocation API cat fielddata API »
Was this helpful?
Feedback