Count Documents Satisfying a Query

POST 
/search/count

Performs a search with a provided query and returns the count of results in the X-Total-Count header.

Request

Responses

204

No content - indicates the request was successful but there is no content to be returned in the response.

Response Headers

• X-Total-Count integer

  Example: 5 The total result count.

400

Client Error - Returned if the request body is invalid.

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

500

Internal Server Error - Returned if there is an unexpected error.