Skip to main content

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.

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

Successful response