# Get a document count


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

**All methods and paths for this operation:**

<div>
                      <span class="operation-verb post">POST</span>
                      <span class="operation-path">/_cat/count</span>
                      </div>
                    <div>
                      <span class="operation-verb get">GET</span>
                      <span class="operation-path">/_cat/count</span>
                      </div>
                    <div>
                      <span class="operation-verb post">POST</span>
                      <span class="operation-path">/_cat/count/{index}</span>
                      </div>
                    <div>
                      <span class="operation-verb get">GET</span>
                      <span class="operation-path">/_cat/count/{index}</span>
                      </div>
                    

Get 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.

IMPORTANT: 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.

NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the `POST` method. This is primarily intended for project routing in serverless environments.

## Required authorization

* Index privileges: `read`



## Servers
- http://api.example.com: http://api.example.com ()


## Authentication methods
- Api key auth
- Basic auth
- Bearer auth


## Parameters

### Path parameters
- **index** (string | array[string])
  A comma-separated list of data streams, indices, and aliases used to limit the request.
  It supports wildcards (`*`).
  To target all data streams and indices, omit this parameter or use `*` or `_all`.

### Query parameters
- **h** (string | array[string])
  A comma-separated list of columns names to display. It supports simple wildcards.

  Supported values include:
    - `epoch` (or `t`, `time`): The Unix epoch time in seconds since 1970-01-01 00:00:00.
    - `timestamp` (or `ts`, `hms`, `hhmmss`): The current time in HH:MM:SS format.
    - `count` (or `dc`, `docs.count`, `docsCount`): The document count in the cluster or index.

- **s** (string | array[string])
  List of columns that determine how the table should be sorted.
  Sorting defaults to ascending and can be changed by setting `:asc`
  or `:desc` as a suffix to the column name.

### Body: application/json (object)

object

## Responses
### 200


#### Body: application/json (array[object])
- **epoch** (number | string)
  seconds since 1970-01-01 00:00:00
- **timestamp** (string)
  time in HH:MM:SS
- **count** (string)
  the document count


[Powered by Bump.sh](https://bump.sh)