IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« cat component templates API cat data frame analytics API »
Elastic Docs ›Elasticsearch Guide [8.11] ›REST APIs ›Compact and aligned text (CAT) APIs

cat count API

edit

cat count API

edit

cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.

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.

Request

edit

GET /_cat/count/<target>

GET /_cat/count

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the read index privilege for any data stream, index, or alias you retrieve.

Path parameters

edit
<target>
(Optional, string) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

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 data stream or index

edit

The following count API request retrieves the document count for the my-index-000001 data stream or index.

response = client.cat.count(
  index: 'my-index-000001',
  v: true
)
puts response
GET /_cat/count/my-index-000001?v=true

The API returns the following response:

epoch      timestamp count
1475868259 15:24:20  120

Example with all data streams and indices in a cluster

edit

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

response = client.cat.count(
  v: true
)
puts response
GET /_cat/count?v=true

The API returns the following response:

epoch      timestamp count
1475868259 15:24:20  121
« cat component templates API cat data frame analytics API »