cat count APIedit

Provides quick access to a document count for a data stream, an index, or an entire cluster.

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

Requestedit

GET /_cat/count/<target>

GET /_cat/count

Path parametersedit

<target>

(Optional, string) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

To target all data streams and indices in a cluster, omit this parameter or use _all or *.

Query parametersedit

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.

Examplesedit

Example with an individual data stream or indexedit

The following count API request retrieves the document count for the twitter data stream or index.

GET /_cat/count/twitter?v

The API returns the following response:

epoch      timestamp count
1475868259 15:24:20  120

Example with all data streams and indices in a clusteredit

The following count API request retrieves the document count for all data streams and indices in the cluster.

GET /_cat/count?v

The API returns the following response:

epoch      timestamp count
1475868259 15:24:20  121