ads
GET /v1/ads/site-tags/{tag_id}
One site tag with its install code.
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} \
-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 §84). Another organisation's tag is a 404.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
tag_id (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
org_id | string | Yes | — |
site_host | string | Yes | — |
public_key | string | Yes | Public (it is in the page source); never an API credential. |
google_ads_id | string | Yes | — |
ga4_id | string | Yes | — |
google_labels | object | Yes | — |
microsoft_uet_id | string | Yes | — |
meta_pixel_id | string | Yes | — |
consent_default | string<denied_eea, denied, granted> | Yes | — |
wait_for_update_ms | integer | Yes | — |
keep_click_ids | boolean | Yes | — |
enabled | boolean | Yes | — |
version | integer | Yes | — |
updated_at | object | Yes | — |
served | object | No | za-126: the ids this site actually serves — its own, else the organisation's tracking hub's. |
install | AdsSiteTagInstall | Yes | — |
shield | object | No | What the click shield has seen through this tag (SHIELDTAG, docs/1006.d/features/za-316-shieldtag.md): when the last paid-click landing beacon arrived and the clicks scored from… |
Errors this endpoint can return
401 · 403 · 404