ads

GET /v1/ads/connections/{connection_id}/country-campaigns

A customer's country campaigns, and the converting countries without one (za-75).

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}/country-campaigns \
  -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. Read from the reading the connection's daily job keeps (docs/1006 COUNTRYCAMP), never a network call in the request; READ ONLY — the build (za-105), the split (za-179) and the budget raise (za-144) keep their own gates. campaigns: every enabled campaign whose only location is one country, with its 7-day budget, share of impressions lost to budget, spend, conversions and cost per conversion, who built it (autopilot — an applied new-country or country-split change, change_id — or you), and what happened about its budget (budget_flag, za-142: raised, suggested, ceiling, recent, flagged); held_by_budget from 50% lost to budget. countries: every country that converted in the last 30 days inside campaigns that are not its own, against the customer's trigger (trigger, set with PATCH /v1/ads/connections/{id}): standing is proposed (a change waits for approval), ready (meets the trigger; the next audit proposes it), watching (not yet), monthly_limit, excluded (the account excludes the country) or off (new-country campaigns or the Campaigns mode are off). state is held, ready, ok or none (no reading yet, or nothing to watch). Money in micros of the account currency. The house account answers state: none.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Response

NameTypeRequiredWhat it is
campaignsAdsCountryCampaign[]Yes—
countriesAdsCountryCandidate[]Yes—
triggerobjectYes—
account_cost_per_conversion_microsobjectYes—
statestring<held, ready, ok, none>Yes—
currencystringYesISO 4217 code of the account.
read_atobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 429