ads

GET /v1/ads/analytics/markers

What happened on each day of the chart - the changes made and the anomalies, each anomaly linked to the changes before it (za-284).

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/markers \
  -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. Per bucket of the chart's grain: the changes APPLIED to an ad account in scope (an undone change too - it happened, then it was taken back), split by who made them (zinn: the daily audit, the autopilot, Simple mode, the assistant; you: a person in the dashboard or the customer's own API key), and the changes Google made in the account by itself (google; google_breaks of them broke one of the customer's own rules). anomalies are the days whose spend or conversions left the account's own pattern of the 14 days before (at least 7 of them with data): beyond three standard deviations, half the mean and a floor of one unit of the currency or two conversions. Today is never judged. Each anomaly counts the changes in the link_days days up to it (linked), and linked_first_day..linked_last_day is the window GET /v1/ads/analytics/markers/items lists them in. Changes are account-level: with a campaign, country, device or product/site filter they are still the whole account's, and narrowed says so. Gated on ads.view over the organisations the person can view; org_id narrows to that organisation and its client organisations; no organisation is a 404. Stored rows only, counted in the database. Anomaly values are integer micros of the reporting currency (conversions in thousandths).

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
dataAdsAnalyticsMarkersYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429