ads

POST /v1/ads/site-tags/{tag_id}/first-party/check

Ask Cloudflare whether the first-party route still serves this site.

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.manage 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 POST https://api.zinndigital.com/v1/ads/site-tags/{tag_id}/first-party/check \
  -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.manage (docs/1006 §105). Records ok, failed (routeMissing: the route was removed or repointed) or needs_token; a temporary Cloudflare failure keeps the previous status. The served script uses the first-party path only while ok.

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 · 503