Skip to main content
POST
curl
Returns one time series per groupBy combination, each with period totals and a per-day metric breakdown. metrics and parameters are required; groupBy and filters are 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
metrics
Field reference Ā· object[]
required

Fields to aggregate.

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.

groupBy
Field reference Ā· object[]

Fields to split the series by.

limit
integer
default:100

Maximum number of series (groupBy values) to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of series to skip.

Required range: x >= 0

Response

OK

series
series Ā· object[] | null
required

One entry per groupBy combination. null when the query matched no data.

Last modified on August 18, 2026