Skip to content

Report runs

A report run is one build of a report template: the parameters that were used (period, filters, columns) and the resulting data. Runs are created when a user runs the report in the web portal or when the schedule of the template fires. See Running reports in the User Guide.

The REST API provides read-only access to report runs. Use it to pull report data into an external system, for example a business intelligence tool.

Endpoints

Request Description
GET /api/v2/reports/<report-id>/runs.json List report runs
GET /api/v2/reports/<report-id>/runs/<run-id>.json View a report run
GET /api/v2/reports/<report-id>/runs/<run-id>/data.json View report run data

In place of <run-id>, the value latest addresses the most recent run of the template.

Typical workflow

  1. Find the template with List and search report templates, or copy its ID from the web portal.
  2. Retrieve GET /api/v2/reports/<report-id>/runs/latest.json and check that celery_status is SUCCESS.
  3. Retrieve GET /api/v2/reports/<report-id>/runs/latest/data.json and map the data rows to the headers.