Run Ad-Hoc Report

POST 
/api/v2/report-builder/run

Run a report definition without saving it. Use this for previewing results before saving a custom report.

Required scope: reports:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

The definition object must include:

• base_entity (string, required): The primary entity to query
• columns (array, required, min 1): Columns to include. Each column needs id, kind (dimension|measure), entity, and field. Optional: label, granularity, aggregation
• filters (object, optional): Filter tree with conjunction (and|or) and children array of conditions/groups
• sorts (array, optional): Sort rules with column_id and direction (asc|desc)
• limit (integer, optional): Max rows (1-5000)

The top-level limit parameter also caps the result set (1-5000).

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.