Skip to main content
pivot_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_-]+$
rowDimensions
object[]
required

Row hierarchy, top level first; subtotals return at every level.

Required array length: 1 - 5 elements
measures
object[]
required
Required array length: 1 - 10 elements
columnDimensions
object[]

Each value combination becomes a column group; omit for row subtotals only.

Maximum array length: 3
where
object[]

Filters source rows before pivoting.

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
sort
object

Defaults to the first measure, descending.

columnTopN
integer

Keeps the top column groups by the first measure's total; defaults to 10.

Required range: 1 <= x <= 50
rowTopN
integer

Keeps the top-level row groups ranked first by sort; omitted, up to 500 row groups return.

Required range: 1 <= x <= 500

Response

200

Tool result.