ads
GET /v1/ads/shield/claims/{claim_id}
One refund evidence pack with every suspected click.
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/claims/{claim_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. Each click: time, gclid, campaign, keyword, network (masked) and ASN, behaviour (requests after the click, repeats), the rebuilt access-log line (address masked) and the reasons it was judged invalid. Up to 2,000 clicks.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
claim_id (path) | string | Yes | — |
org_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
connection_id | string | Yes | — |
account | string | Yes | The Google Ads customer id. |
account_label | string | Yes | — |
month | string | Yes | — |
status | string<ready, filed, credited, declined> | Yes | — |
clicks | integer | Yes | — |
estimated_cost_minor | integer | Yes | — |
currency | string | Yes | — |
filed_at | object | Yes | — |
reference | string | Yes | — |
credited_minor | object | Yes | The invalid-activity credit for the month read from the account's invoices (null = none seen yet). |
credit_checked_at | object | Yes | — |
credit_note | string | Yes | no_monthly_invoicing when the account has no invoices to read. |
google_form_url | string | Yes | Google's invalid-click investigation form. |
first_click_at | object | Yes | — |
last_click_at | object | Yes | — |
claim_deadline | object | Yes | — |
by_reason | object | Yes | — |
campaigns | string[] | Yes | — |
clicks_list | AdsShieldClick | object[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429