ads
GET /v1/ads/analytics/funnel
The funnel impression -> click -> conversion -> paid, and the customer's own measured outcomes beside the network's conversions (za-282).
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/analytics/funnel \
-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
Over the same filters as the other analytics reads. Impressions, clicks and conversions are the networks' stored daily figures under every filter. paid is the sales (purchases and upgrades, not refunded in full) the customer's OWN source recorded (store, checkout, plugin, CRM or the events API); a sale recorded on more than one ad account counts once per organisation. truth puts, per ad account that has ever sent an outcome, the conversions the network counted beside the outcomes the customer's own source recorded on the same days (the kinds the account's tracking settings compare), the gap, and the latest daily tracking-truth check. An account that never sent an outcome has no truth (never zero): it is counted in untracked_accounts and left out of both sides. Outcomes carry no campaign, country, device or product/site: with any of those filters attributable is false, not_split_by names them, truth and the paid step are null. Gated on ads.view over the organisations the person can view; org_id narrows to that organisation and its client organisations. Outcomes are windowed on each ad account's own day, in the account's stored time zone (UTC when none is stored yet), the same days as the network's figures and the daily tracking-truth check. A person who may view no organisation is refused (404), never answered with an empty frame. Stored rows only, never a network call. Money is integer micros of the reporting currency at the current stored rate (fx).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
range (query) | string<7d, 30d, 90d, ytd, 12m, custom> | No | The period. custom takes from and to. |
from (query) | string | No | — |
to (query) | string | No | — |
compare (query) | string<previous, year, none> | No | — |
grain (query) | string<day, week, month> | No | Bucket size. Default day up to 92 days, week up to 366, month beyond. |
network (query) | string | No | Comma-separated networks (google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon). |
connection (query) | string | No | Comma-separated ad-account connection ids. |
campaign (query) | string | No | Comma-separated <connection_id>:<campaign_id> tokens. |
country (query) | string | No | Comma-separated ISO 3166-1 alpha-2 codes. Reads the country-level figures. |
device (query) | string | No | Comma-separated devices: mobile, desktop, tablet, tv, other (za-282). Reads the device-level figures (Google Ads accounts, campaign grain). No stored level is split by… |
offering (query) | string | No | Comma-separated product/site ids (za-290), or unassigned. |
client (query) | string | No | za-287: comma-separated client organisation ids. The read narrows to each client and its own clients, so an agency sees the same screen for one client. A client the caller cannot… |
currency (query) | string | No | Reporting currency (ISO 4217). Default the one currency in play, else the organisation's. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AdsAnalyticsFunnel | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429