ads

GET /v1/ads/connections/{connection_id}/paid-geo

Paid revenue by country and by campaign device, and what it proposes (za-168).

All ads endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

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.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

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/connections/{connection_id}/paid-geo \
  -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. The latest reading the connection's daily audit stored (docs/1006 §PAIDGEO) — never a network call in the request. Only conversion actions on stage 3 of the signal ladder (a sale) count: sales and revenue_minor (integer minor units of currency) are PAID-customer figures; sign-ups, trials and activations never move a country or a device. Country verdict: campaign (at least min_sales sales and country_share_pct percent of the account's paid revenue — proposed its own campaign), ownCampaign, excluded, belowShare, learning. Device verdict: up / down (with proposed_modifier), hold, learning, deviceExcluded. outcome: queued, approved, alreadyProposed, campaignsOff, bidsOff, refused:adBelowGood, noAdGroups, or empty. state noPaidSignal while the account has fewer than min_account_sales paid sales in the window (nothing is judged). Every threshold is the customer's own (value, null = following recommended). reading is null before the first audit.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Response

NameTypeRequiredWhat it is
dataAdsPaidGeoYesza-168 (docs/1006 §PAIDGEO) — paid revenue by country and device.

Errors this endpoint can return

401 · 403 · 404 · 429