ads

POST /v1/ads/connections/{connection_id}/reviews

Schedule a review; its own Temporal workflow judges it on the due day (AUTOREVIEW1).

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.manage 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 POST https://api.zinndigital.com/v1/ads/connections/{connection_id}/reviews \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "title": <string> }'

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.manage; audit action ads.review_create. Closed sets only: subject (results, change, experiment, quality, funnel), options (keep, pause, revert, extend; default per subject). The due day is due_on or days from today (after today, within a year); measure_from (default today) starts the judged window, and the same number of days before it is the baseline. A change review names the applied change (change_id) whose Undo is its revert. Pause and Quality Score reviews are Google only (422 reviewPauseGoogleOnly, reviewQualityGoogleOnly). Creating a review changes nothing in the ad account.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
subjectstring<results, change, experiment, quality, funnel>No—
titlestringYes—
questionstringNo—
due_onstringNo—
daysintegerNo—
measure_fromstringNo—
campaign_idsstring[]No—
change_idstringNo—
optionsstring<keep, pause, revert, extend>[]No—

Response

NameTypeRequiredWhat it is
dataAdsReviewYesA scheduled review (AUTOREVIEW1). figures are the measurements the verdict rests on: the judged window (after) and the same length before it (before) with impressions,…

Errors this endpoint can return

401 · 403 · 404 · 422 · 429