Skip to main content
POST
Aggregate an entity: group-by + measures (counts/sums/etc.)

Authorizations

Authorization
string
header
required

API key passed as Bearer token (e.g. "Bearer your-api-key")

Path Parameters

entity
string
required

Curated entity name — see GET /query/describe for the set the host exposes.

Body

application/json
groupBy
string[]
required
Minimum array length: 1
Minimum string length: 1
measures
object[]
required
Minimum array length: 1
filter
object

Recursive filter expression: a leaf {on, op, value} or an and/or/not combinator of nested filter expressions. Nesting depth is unlimited at runtime; this doc schema shows two levels.

sort
object[]
limit
integer
Required range: 1 <= x <= 1000
include_sql
boolean
scope
object

Response

entity
string
required
groups
object[]
required
groupCount
integer
required
truncated
boolean
required
sql
string
params
any[]