ads

POST /v1/ads/analytics/views

Save the current analytics view under a name (za-286).

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 field in the JSON body.

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 POST https://api.zinndigital.com/v1/ads/analytics/views \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "params": <AdsSavedViewParams> }'

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; scheduling its e-mail (mail_cadence, mail_recipients) needs ads.manage (422 viewMailManage). Audit action ads.saved_view.save. params is validated by the analytics filters themselves, so a view never stores a filter the page would refuse (422 savedView naming the field). A name already used in the organisation answers 422 viewNameTaken. Recipients are user ids of MEMBERS of the organisation (GET /v1/ads/analytics/views/recipients), at most 20, else 422 viewRecipients.

Request body

NameTypeRequiredWhat it is
org_idstringNo—
namestringYes—
paramsAdsSavedViewParamsYesThe /ads/analytics filters, exactly the analytics API's query parameters (only those set).
chartAdsSavedViewChartNo—
mail_cadenceAdsSavedViewCadenceNo—
mail_recipientsstring[]No—

Response

NameTypeRequiredWhat it is
dataAdsSavedViewYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429