ads
GET /v1/ads/report
Reporting per ad account and per agency client (za-23).
Authentication
Send an API key as a bearer token. The key must carry the ads.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/ads/report \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Gated on ads.view. Every connected ad account in the organisations the person can view — for an agency its own organisation and every client organisation below it — with spend, clicks, impressions, conversions, conversion value and ROAS over the last days days, the fraud the click shield blocked (exclusions added, their clicks and measured cost), the invalid-activity credit recovered, and what the autopilot changed (applied in the window, waiting now). clients totals the accounts per client organisation, one row PER CURRENCY (money is never summed across currencies). org_id narrows to that organisation and its clients. connection_id adds detail: that account's figures by campaign, product and country. Stored rows only (the daily audit's figures) — never a network call in the request. Spend and value are micros of the account currency; conversions are thousandths; ROAS is basis points (10000 = 1x, null with no spend); shield figures are minor units.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
days (query) | integer<7, 30, 90> | No | — |
connection_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AdsReport | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429