ads

GET /v1/ads/analytics/impact

How Zinn® Ads helped - money saved, fraud blocked, refunds won, conversions recovered, changes and before vs after (za-281).

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.

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/analytics/impact \
  -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

Over the same filters as the other analytics reads: wasted spend blocked (search terms and keywords the audit found spending with no conversion, then blocked or paused, with the measured cost and clicks before the block), invalid clicks excluded by the click shield (their measured cost), credits the network granted for invalid activity, conversions Zinn® Ads uploaded that the network's own tag had missed, the changes Zinn® Ads made by kind (changes the customer made, in the dashboard or with their own API key, are not counted) with how many can still be undone, the self-check verdicts of the changes scored in the period, and ROAS over the 90 days before the first account was connected and since. money_saved_micros is waste blocked plus, per account and currency, the larger of fraud blocked and refunds won (a credit refunds the same invalid clicks the exclusions measured, so that money is counted once), all measured. hours_saved is a MODEL (changes times the stated minutes per change), flagged modelled: true. Each list is the latest 20 items with the full count beside it; a waste item carries the change that blocked it and whether it can still be undone. Network and account filters apply to every section. The campaign filter narrows waste blocked, fraud blocked (account-level exclusions stay), the self-check verdicts and before vs after; refunds won, conversions recovered and changes made are account-wide and ignore it. Country and product/site filters apply to before vs after only. A fraud item's Undo is offered only where the server accepts it: Google has named it, no removal is under way, and it was applied inside the 30-day undo window. Gated on ads.view over the organisations the person can view; org_id narrows to that organisation and its client organisations. Stored rows only, never a network call. Money is integer micros of the reporting currency at the current stored rate (fx).

Parameters

NameTypeRequiredWhat it is
org_id (query)stringNo—
range (query)string<7d, 30d, 90d, ytd, 12m, custom>NoThe period. custom takes from and to.
from (query)stringNo—
to (query)stringNo—
compare (query)string<previous, year, none>No—
grain (query)string<day, week, month>NoBucket size. Default day up to 92 days, week up to 366, month beyond.
network (query)stringNoComma-separated networks (google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon).
connection (query)stringNoComma-separated ad-account connection ids.
campaign (query)stringNoComma-separated <connection_id>:<campaign_id> tokens.
country (query)stringNoComma-separated ISO 3166-1 alpha-2 codes. Reads the country-level figures.
device (query)stringNoComma-separated devices: mobile, desktop, tablet, tv, other (za-282). Reads the device-level figures (Google Ads accounts, campaign grain). No stored level is split by…
offering (query)stringNoComma-separated product/site ids (za-290), or unassigned.
client (query)stringNoza-287: comma-separated client organisation ids. The read narrows to each client and its own clients, so an agency sees the same screen for one client. A client the caller cannot…
currency (query)stringNoReporting currency (ISO 4217). Default the one currency in play, else the organisation's.

Response

NameTypeRequiredWhat it is
dataAdsAnalyticsImpactYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429