ads

GET /v1/ads/connections/{connection_id}/placement-goals

Every top-of-page goal, measured, diagnosed and priced (za-187).

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}/placement-goals \
  -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 with a top-of-page goal (docs/1006 §47) — its main keywords, the target share of the top (top) or absolute top (absolute_top) of the page, the max CPC and daily budget (0: priced for you) — and report, the daily audit's latest reading: the measured share and verdict (on_target / off_target / no_data) and, below target, the causes in order (missing_keywords, ad_relevance, landing_page, expected_ctr, then bid and budget) with each fix, and the priced proposals (Target impression share with a max CPC from the network's own top-of-page bid estimates; the budget that buys about min_top_clicks top-of-page clicks a day; or concentrate when the monthly ceiling cannot fund it as well). campaigns: the Search campaigns a goal can be set on. Never a network call in the request; at most 500.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Response

NameTypeRequiredWhat it is
dataAdsPlacementGoal[]Yes—
campaignsobject[]Yes—
placementsstring<top, absolute_top>[]Yes—
min_top_clicksintegerYesThe budget floor: a budget must buy about this many top-of-page clicks a day.
max_keywordsintegerYes—

Errors this endpoint can return

401 · 403 · 404 · 429