Skip to main content
POST
curl
Returns rows, each a flat object of the requested fields. metrics and parameters are required; groupBy, filters, and orderBy are optional, though orderBy is required when groupBy is set. 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

When groupBy is set, orderBy is required.

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 rows by.

limit
integer
default:1000

Maximum number of rows to return.

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

Number of rows to skip.

Required range: x >= 0
orderBy
Order definition Ā· object[]

Sort specification. Required when groupBy is set.

Response

OK

rows
object[]
required

Result rows. Each row is a flat object of the requested fields.

Last modified on August 18, 2026