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 querycolumns(array, required, min 1): Columns to include. Each column needsid,kind(dimension|measure),entity, andfield. Optional:label,granularity,aggregationfilters(object, optional): Filter tree withconjunction(and|or) andchildrenarray of conditions/groupssorts(array, optional): Sort rules withcolumn_idanddirection(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