ads

GET /v1/ads/site-tags/{tag_id}/first-party

First-party tracking for this site on the customer's own Cloudflare (za-123).

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/site-tags/{tag_id}/first-party \
  -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 (docs/1006 §105). status is off until a token is connected, then ok, needs_token (the customer must fix the token or zone) or failed (last_error). snippet is the first-party install: the universal script from /ztag/{public_key}.js on the site's own host. Never returns the token: token_hint is its last four characters.

Parameters

NameTypeRequiredWhat it is
tag_id (path)stringYes—

Response

NameTypeRequiredWhat it is
statusstring<off, ok, needs_token, failed>Yes—
pathstringYesThe path on the site host: /ztag.
providerstringNo—
zone_namestringNo—
route_patternstringYes—
script_namestringNo—
last_errorstringNoAn error code: tokenRejected, permissionMissing, zoneNotFound, rateLimited, unavailable, unexpected or routeMissing; empty when ok.
token_hintstringNoThe token's last four characters
checked_atstringNo—
snippetstringYes—

Errors this endpoint can return

401 · 403 · 404