ads
GET /v1/ads/connections/{connection_id}/geo-holdouts
The account's geo hold-outs — incrementality tests by country (za-202).
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}/geo-holdouts \
-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 geo hold-out of the connection (newest first, at most 200) and the customer's thresholds. Before a budget raise at or over the threshold, one country is held out of the campaign for days, resumed by its own Undo, and the account's real first-party sales are compared with their trend: lift (with the measured incrementality), noLift, or inconclusive with its reason (tooFewSales, underpowered, noSignal, endedEarly). Read from our own rows — never a network call (docs/1006 §80).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
connection_id (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AdsGeoHoldout[] | Yes | — |
settings | AdsGeoHoldoutSettings | Yes | The customer's geo hold-out thresholds (za-202); Recommended where never set. |
Errors this endpoint can return
401 · 403 · 404 · 429