ads

GET /v1/ads/analytics/forecast

This month's spend so far, the month-end forecast with its band, and the spend ceiling it is held against (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/forecast \
  -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

Always the CURRENT month (UTC), over the screen's network, account, campaign, country, device and product/site filters (its date range does not apply). The forecast is the pacing card's own, per account: what it spent this month before today plus its mean daily spend over the last rate_days complete days for every day left, today included (on the account's own weekday pattern when its pacing strategy is day_of_week). The band is a MODEL: each day left varies like the last rate_days did, days independent, accounts summed by variance; low..high is the central band_pct% and never below what is spent. days is one point per day of the month: actual (cumulative spend) before today, mid/low/high from today to the month's last day. ceiling: the organisation's one cross-network monthly ceiling when every live account of it is in scope, else the sum of the accounts' own monthly ceilings; complete is false when an account in scope that spends has none (missing counts them), and comparable is false under a campaign, country, device or product/site filter (a ceiling is per account). state: no_spend, no_ceiling, at_ceiling (spent), over (the forecast passes it), at_risk (the band's top passes it) or under. Gated on ads.view like the other analytics reads. Stored rows only. 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
dataAdsAnalyticsForecastYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429