ads
GET /v1/ads/social
The social-network autopilot on this org's X, Meta and TikTok accounts.
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/social \
-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). Per X and Meta account: levers says what the autopilot judges there (audiences and creatives are judged by the scheduled audit; Meta placements by the placement guard and budgets by the cross-network budget, elsewhere with the screen in where; X offers no placement change on a running line item, not_offered). review is the latest audit: audiences (X line items, Meta ad sets) and creatives (X promoted Tweets, Meta ads) judged, the spend found wasted (waste_micros, micros of the account currency: spend with no conversion), what was proposed or applied and findings (at most 50). A creative is stopped only while its audience keeps another creative that is not waste. needs_permission means Meta has not granted Zinn® Ads ads_management (Pinterest: ads:write, PINFULL), or (TTFULL) TikTok answered that this grant cannot write (measured, vendor_grants.writes false): judged, nothing proposed. TikTok and Pinterest audiences are ad groups and their creatives are ads (Pinterest: promoted Pins), and only SERVING ones are judged. pending counts the pauses waiting for a person (docs/1006 §121, za-55).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
accounts | object[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429