ads
GET /v1/ads/connections/{connection_id}/tiktok/objects
A TikTok advertiser's campaigns, ad groups and ads with status, budget, bid and 7-day spend (TTFULL).
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.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
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/connections/{connection_id}/tiktok/objects \
-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 TikTok now (TTFULL, docs/1006 §TikTok writes): every campaign, ad group and ad TikTok lists (deleted ones it does not), whether each is serving, its own budget and bid (null where it has none), the audiences an ad group excludes and its spend over the last since_days days. grants is what this connection's grant may do, measured from TikTok's answers (writes, audiences, diagnosis; absent = not measured yet). Refusals (422): noSuchConnection (not a TikTok connection), needsReconnect.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
connection_id (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
since_days | integer | Yes | — |
currency | string | Yes | ISO 4217 code of the ad account. |
grants | object | Yes | — |
campaigns | object[] | Yes | — |
adgroups | object[] | Yes | — |
ads | object[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429