Skip to main content
POST
Group and aggregate rows on the server (direct readers)

Body

application/json
base
string
required

Base id or slug

agg
string[]

Measures: count, count::n, sum:amount, avg:amount:avg_deal (default: count)

console
string

Console base URL

filter
string

Query AST filter, inline JSON or @file

groupBy
string

Comma-separated, up to 2 keys, e.g. created_time:month,status; dates need a unit: day|week|month|quarter|year

project
string

Console project id or slug; overrides the saved Console scope

Response

Success — body conforms to the @Returns schema.

baseRef
string
required
consoleUrl
string
required
groups
object[]
required
projectRef
string
required
success
boolean
required
suppressedGroups
number
required
users
object
required