Reports
List Ad Reports
Lists saved advertising reports ordered by name, with their definition, delivery schedule, last send and next run. Paginated (default 10, max 100 per page).
Create Ad Report
Saves a report definition, optionally with a scheduled delivery by email and/or Slack. Scheduled reports are sent automatically at `next_run_at`.
Run Ad Report
Runs an ad-hoc advertising report from a definition and returns the rows without saving anything. Each row carries a label and an `<dimension>_id` for every dimension plus the requested metrics; `columns` lists the column keys and labels in order. Ratios are fractions (0.1956 = 19.56%) and contribution-based metrics are null without product cost data. `notes` explains estimates, unmapped spend, currency caveats and truncation.
Export Ad Report
Runs an ad-hoc report definition and downloads the result as a CSV (default) or XLSX file named `ads-report-YYYYMMDD-HHMMSS.<ext>`, with one column per dimension label and metric.
Get Ad Report
Returns one saved report with its stored definition and schedule. Returns 404 for an unknown report.
Update Ad Report
Updates a saved report. Every field is optional; send only what changes. When `definition` is sent, its `metrics` and `dimensions` keys are required inside it, and the whole definition is replaced.
Delete Ad Report
Deletes a saved report and stops its schedule. Returns 204 with no body. The deletion is logged.
Run Saved Ad Report
Runs a saved report's definition now and returns the rows (same shape as Run Ad Report). A relative window is evaluated against today. Returns 422 if the stored dimensions cannot be combined.
Export Saved Ad Report
Runs a saved report and downloads it as a file named after the report (`weekly-poas-by-campaign-YYYYMMDD-HHMMSS.<ext>`). Uses the report's saved `format` unless `file_type` is given.
Send Ad Report
Delivers a saved report to its email recipients and/or Slack webhook now, outside its schedule. Runs as a queued, tracked background job; poll the returned `tracked_job_log_id`. No request body.