ads
GET /v1/ads/shield
The organisation's click-fraud shield and its totals for a period.
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.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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/shield \
-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 §15). Paid clicks (gclid, msclkid, fbclid, ttclid, li_fat_id, twclid, epik) that landed on the organisation's sites hosted by Zinn®, scored from the sites' own access logs. estimated_wasted is an ESTIMATE in integer minor units — suspected clicks times the organisation's own avg_cpc_minor — never a refund promise; Google decides what is invalid. The shield is free on all Zinn® hosting and on by default. With a connected Google Ads account the estimate uses Google's own measured average CPC for the click's keyword (else campaign) that day (estimate_sources).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
days (query) | integer<7, 30, 90> | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | Yes | — |
enabled | boolean | Yes | — |
avg_cpc_minor | integer | Yes | — |
currency | string | Yes | — |
conversion_paths | string[] | Yes | — |
period_days | integer | Yes | — |
clicks | integer | Yes | — |
suspected | integer | Yes | — |
converted | integer | Yes | — |
by_reason | object | Yes | — |
estimated_wasted | object[] | Yes | — |
suspect_at | integer | Yes | — |
reasons_known | string[] | Yes | — |
claim_window_days | integer | Yes | — |
retention_days | integer | Yes | — |
estimate_sources | object | No | How many estimated costs came from Google's measured average CPC for the click's keyword (keyword_day) or campaign (campaign_day) that day, or from the organisation's own… |
exclusions_enabled | boolean | No | — |
exclusions | object | No | The organisation's shield exclusions counted by status. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429