Skip to main content
POST
Run an inline report definition synchronously

Body

application/json

The report-definition document: one contract drives sync runs, exports, saved definitions and schedules. select holds 1 to 50 entries. See docs/API.md for the full rules.

dataset
string
required

A dataset name from GET /datasets

select
object[]
required
Required array length: 1 - 50 elements
filters
object | null

Filter tree node: exactly one of and/or/not (branch, nesting depth at most 3) or field+op (leaf). value is kept raw and type-checked against the catalog during compilation.

groupBy
string[] | null

Required iff any select entry aggregates; every plain select entry must appear here, referenced by field name or alias

orderBy
object[] | null
limit
integer<int32> | null

Clamped to 10,000 (sync) / 5,000,000 (export)

Response

OK

runId
string
required
columns
object[]
required
rows
any[][]
required
rowCount
integer<int32>
required
truncated
boolean
required

true → the sync row cap was hit; use an export

statusScope
string
required

Which payslip statuses applied: FINAL (implicit default) | PREVIEW | ALL

executionMs
integer<int64>
required