ads

GET /v1/ads/connections/{connection_id}/conversion-setup

Conversion setup — GA4 key-event import or the server-side upload, each measured (za-12).

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.

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}/conversion-setup \
  -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. Reads the account live (every conversion action, the upload actions and, for the chosen GA4 key events, the conversions credited over the last quiet_days) and spends nothing. ga4 (Google only; {} on Microsoft) lists the key events of every GA4 property linked to the ad account — Google shows one not yet imported as HIDDEN. server says whether the upload action exists, which outcome kinds use it and how many real outcomes arrived and were uploaded in the window. Each step carries a measured state. quiet_days is the customer's own window; recommended_quiet_days our default. A read that failed leaves the steps unreadable with failure (a VendorFailure).

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Response

NameTypeRequiredWhat it is
connection_idstringYes—
platformstringYes—
customer_idstringYesThe ad account id (digits) the customer links GA4 to.
methodstring<, ga4, server>Yes—
quiet_daysintegerYes—
recommended_quiet_daysintegerYes—
quiet_days_minintegerYes—
quiet_days_maxintegerYes—
ga4_property_idstringYes—
ga4_key_eventsstring[]Yes—
needs_reconnectbooleanYes—
failureVendorFailureYes—
ga4objectYesGoogle only; empty on Microsoft.
serverobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429