Skip to main content
POST
Run Report Query
Runs a report query and returns the summary behind the chart (a cell per view × segment, view and segment totals, the grand total) and a page of records. Rows are limited to the token’s organization.
  • Periods such as last_week are resolved in the timezone you send; weeks start on Monday.
  • User filters accept "me" for the caller.
  • An invalid query returns 422 naming the bad part (detail.path); a report that runs longer than 10 seconds returns 504.
Requires a CRM read scope.

Authorizations

Authorization
string
header
required

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

Body

application/json
query
ReportQuery · object
required
timezone
string
default:UTC

Viewer's IANA timezone, e.g. Africa/Accra.

page
integer
default:0
Required range: 0 <= x <= 99
page_size
integer
default:50
Required range: 1 <= x <= 200
include_summary
boolean
default:true

False skips the chart figures (summary comes back empty), for paging, sorting or changing columns.

Response

Successful Response

period
ResolvedPeriod · object | null
required
summary
ReportSummary · object
required
records
ReportRecords · object
required
comparison
ReportComparison · object | null

The compared period's figures, when asked for.