Skip to main content
aggregate_table

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tableId
string
required

Data table or worksheet id.

Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]+$
select
object[]
required

Measures to compute; grouped columns appear in results without an entry here.

Required array length: 1 - 20 elements
groupBy
object[]

Omit for one scalar row over the whole table.

Maximum array length: 10
where
object[]

Filters rows before aggregation.

Maximum array length: 20
arrayExpansions
object[]

Explode array columns into one row per element, referenced by alias; empty arrays yield no rows, and counts describe elements, not records.

Maximum array length: 3
having
object[]

AND-combined filters on measure values, applied after aggregation and before sorting and paging.

Maximum array length: 20
orderBy
object[]

Sort keys in priority order; defaults to the first groupBy column, ascending.

Maximum array length: 10
limit
integer

Defaults to 100.

Required range: 1 <= x <= 10000
offset
integer

Zero-based offset over groups.

Required range: 0 <= x <= 9007199254740991

Response

200

Tool result.