Skip to main content
POST
curl
Buckets one or more numeric fields into histograms and returns an object keyed by histogram<Field>, each mapping a bin label to a count. distributions and parameters are required; filters is optional. Discover valid field kinds per domain with /3/patterns/fields. Required ACL: analytics

Authorizations

x-algolia-application-id
string
header
required

Your Algolia application ID.

x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

index
string

Comma-separated list of indices the request runs on, used for authorization. Required for index-restricted API keys and must match the indices supplied in the request body's indices parameter; optional for unrestricted keys.

Body

application/json
distributions
Distribution definition Ā· object[]
required

Histogram specifications.

parameters
Parameter definition Ā· object[]
required

Literal values referenced by the query.

domain
string

Default domain propagated to entries that omit their own.

Example:

"core"

filters
Filter definition Ā· object[]

Filter conditions.

Response

OK

Object keyed by histogram<Field>, each mapping a bin label to a count.

Last modified on August 18, 2026