get https://api.kevel.co/v2/reportruns
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
| Type | Property |
|---|---|
| uuid | Array of UUID (one or more) of report IDs |
| report_schedule_id | Array of integers (one or more) representing Scheduled Report IDs |
| trigger | Array of enums (one or more): ui, scheduled, api |
| type | Array of enums (one or more):custom, pacing |
| id | Array of integers (one or more) representing the ID of the Report Run (not the ID of the report) |
Response Params
| Property | Description |
|---|---|
items(array) | Array of objects (or empty), where each object represents an individual Report Run |
Result Properties
| Property | Description |
|---|---|
uuid(string) | UUID of the report - it can be used to retrieve report results, poll for status via the Queued Report API, or accessed via the UI. |
id(integer) | Unique ID of the report run (not the report ID) |
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 |
report_schedule_id(integer) | Integer representing the ID of the scheduled report (configuration) as per Scheduled Reports UI |
report_run_csv_url(string) | Publicly accessible URL (e.g. can be embedded in emails) to retrieve the report results CSV. This is only present for "trigger": "scheduled" , in other words reports generated of the back of a schedule (Scheduled Report). The URL accepts an optional customizable filename query string parameter, E.g. <https://reports.adzerk.com/r/5ad75fb4-5fe7-4a48-93ba-45e9588c84eb/srr/12345/e/1234?filename=AcmeShop> which would result in the following Response header: Content-Disposition: attachment; filename="AcmeShop.csv"; filename\*=UTF-8''AcmeShop.csv resulting in the users browser/email client saving the file as AcmeShop.csv. In the absence of filename query parameter, it would default to: kevel-report-5ad75fb4-5fe7-4a48-93ba-45e9588c84eb.csv |
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. |