ads

GET /v1/ads/cross-budget

The organisation's one monthly ceiling across every ad network, and today's proposal.

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/cross-budget \
  -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. Read from our own rows (no network call): each network's last-30-day spend, conversions and value, why money does not move to or from one (reason: otherCurrency, held, unreadable, noReturn), and the proposal (the new monthly ceiling per network, never past the one ceiling; blocked: noReturnYet until at least one network has a measured return). Measured once a day by a Temporal workflow (docs/1006 §67).

Parameters

NameTypeRequiredWhat it is
org_id (query)stringNo—

Response

NameTypeRequiredWhat it is
org_idstringYes—
ceiling_minorobjectYes—
currencyobjectYes—
modestring<suggest, auto>Yes—
measured_atobjectYes—
networksAdsCrossBudgetNetwork[]Yes—
proposalobjectYes—
last_applyobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429