Get Report Runs

Every time a report is executed (UI, API or scheduled), a new Report Run record is generated and can be access via the UI or this API endpoint with the help of filters and pagination. Report Runs are persisted for 10 days, after which they are deleted as report results are only stored for up to 10 days.

What You Can Filter By

TypeProperty
triggerui, scheduled, api
typecustom, pacing

Response Params

PropertyDescription
items
(array)
Array of objects (or empty), where each object represents an individual Report Run

Result Properties

PropertyDescription
id
(integer)
Unique ID of the report run
uuid
(string)
UUID of the report run, it can be used to retrieve report results, poll for status or accessed via the UI.
trigger
(string)
Trigger ("ui", "api", "scheduled") indicating where report originated from
network_id
(integer)
Network ID to which this report run belongs
created_at
(string)
The time at which the report was submitted (e.g. "2024-03-25T16:14:51Z")
report_template_id
(integer)
Integer representing the ID of report template used for this report run
report_template_version_id
(integer)
Integer representing the ID of the specific version / instance of report template used for this report run
report_type
(string)
Type ("custom", "pacing") of report
status
(object)
Object containing properties ("json-status", "csv1-status", "redshift-status") explained below
status.json-status
(string)
Status("done", "error" or null for "processing") of the report results JSON (post-processed) indicating whether the report can be retrieved via the API Poll for Queued Report
status.csv1-status
(string)
Status ("done", "error" or null for "processing") of the report results CSV (post-processed) indicating whether the report can be retrieved via the download CSV link
status.redshift-status
(string)
Status("done", "error" or null for "processing", "too-large") of the report execution. This has to be "done" before either the JSON or CSV output can be processed.
Language
Authorization
Header