ads

GET /v1/ads/connections/{connection_id}/matching-pages/{page_id}/preview

The server-rendered page, exactly as it will be published (za-N6).

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}/matching-pages/{page_id}/preview \
  -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 full HTML document (title, description, canonical, hreflang alternates, JSON-LD, the language's own direction) in the site's own language or, with locale, one of its translations. 422 landingPageState before the page is written.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—
page_id (path)stringYes—
locale (query)stringNo—

Response

NameTypeRequiredWhat it is
dataobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429