ads

GET /v1/ads/connections/{connection_id}/objectives

Every campaign's objective, the proposal waiting and the judgement against it (za-184).

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}/objectives \
  -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. One row per campaign the daily audit has read (docs/1006 §43) — never a network call in the request. objective is the one in force (null: none — the campaign is judged and bid exactly as before objectives existed); pending a proposal that changes nothing until a person approves it; judgement the latest daily verdict against the objective (on_target / off_target / no_data) with its figures in words; ladder the bid-strategy ladder's verdict, which the objective steers (§39). Campaigns with an objective or a proposal first; at most 500.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Response

NameTypeRequiredWhat it is
dataAdsCampaignObjectiveRow[]Yes—
kindsstring<leads, revenue, profit, top_of_page, brand_defence, traffic, reach>[]Yes—

Errors this endpoint can return

401 · 403 · 404 · 429