Count search results

POST also GET /{index}/_count
POST also GET /_count

Get the number of documents matching a query.

The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. The query is optional. When no query is provided, the API uses match_all to count all the documents.

The count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.

The operation is broadcast across all shards. For each shard ID group, a replica is chosen and the search is run against it. This means that replicas increase the scalability of the count.

Required authorization

Index privileges: read

Path Parameters

index union IndexName | [] IndexName optional

A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (*). To search all data streams and indices, omit this parameter or use * or _all.

Leave it out to use /_count.

Query Parameters

allow_no_indices boolean · default: true

A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

analyzer string

The analyzer to use for the query string. This parameter can be used only when the q query string parameter is specified.

analyze_wildcard boolean · default: false

If true, wildcard and prefix queries are analyzed. This parameter can be used only when the q query string parameter is specified.

default_operator enum Operator · default: or

The default operator for query string query: and or or. This parameter can be used only when the q query string parameter is specified.

Values: and AND or OR

df string

The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the q query string parameter is specified.

expand_wildcards string ExpandWildcards · default: open

The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

Supported values include:

all: Match any data stream or index, including hidden ones.
open: Match open, non-hidden indices. Also matches any non-hidden data stream.
closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

ignore_throttled boolean · default: true deprecated

If true, concrete, expanded, or aliased indices are ignored when frozen.

ignore_unavailable boolean · default: false

If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

lenient boolean · default: false

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the q query string parameter is specified.

min_score number

The minimum _score value that documents must have to be included in the result.

preference string

The node or shard the operation should be performed on. By default, it is random.

routing union Routing

A custom value used to route operations to a specific shard. Not allowed when index.slice.enabled is true for the target index; use _slice instead.

One of: string or string[]

stats union [] string | string

Specific tag of the request for logging and statistical purposes.

One of: string[] or string

terminate_after number

The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.

q string

The query in Lucene query string syntax. This parameter cannot be used with a request body.

Request

query {} QueryContainer: Defines the search query using Query DSL. A request body query cannot be used with the q query string parameter.

Response

application/json

Examples

Run POST /my-index-000001/_count?q=user:kimchy. Alternatively, run GET /my-index-000001/_count with the same query in the request body. Both requests count the number of documents in my-index-000001 with a user.id of kimchy.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /my-index-000001/_count
{
  "query" : {
    "term" : { "user.id" : "kimchy" }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.count({
  index: "my-index-000001",
  query: {
    term: {
      "user.id": "kimchy",
    },
  },
});

Python Elasticsearch Python Client

resp = client.count(
    index="my-index-000001",
    query={
        "term": {
            "user.id": "kimchy"
        }
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_count" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": {
      "term": {
        "user.id": "kimchy"
      }
    }
  }'

Java Elasticsearch Java Client

client.count(c -> c
    .index("my-index-000001")
    .query(q -> q
        .term(t -> t
            .field("user.id")
            .value(FieldValue.of("kimchy"))
        )
    )
);

C# Elasticsearch .NET Client

var response = await client
    .CountAsync(d1 => d1
        .Indices(new[] { "my-index-000001" })
        .Query(d2 => d2
            .Term(d3 => d3
                .Field(x => x.User.Id)
                .Value("kimchy")
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->count([
    "index" => "my-index-000001",
    "body" => [
        "query" => [
            "term" => [
                "user.id" => "kimchy",
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.count(
  index: "my-index-000001",
  body: {
    "query": {
      "term": {
        "user.id": "kimchy"
      }
    }
  }
)

Response

{
  "count": 1,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  }
}

Required authorization

Path Parameters

Query Parameters { allow_no_indices , analyzer , analyze_wildcard , default_operator , df , expand_wildcards , ignore_throttled , ignore_unavailable , lenient , min_score , preference , routing , stats , terminate_after , q , }

Request

Response

Query Parameters