cat count API

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

GET /_cat/count/<index>

GET /_cat/count

Path parameters

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

Query parameters

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

Example with an individual index

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

GET /_cat/count/twitter?v

The API returns the following response:

epoch      timestamp count
1475868259 15:24:20  120

Example with all indices in a cluster

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

GET /_cat/count?v

The API returns the following response:

epoch      timestamp count
1475868259 15:24:20  121