ads

GET /v1/ads/connections/{connection_id}/acquisition-quality

Customer quality per keyword, ad group and country — bad-customer rate against the rest of the account (za-215).

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}/acquisition-quality \
  -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. Refreshed by the connection's daily audit (docs/1006 §45) — never a network call in the request. Every paid customer is traced to the keyword, ad group and country that acquired them; a customer is BAD when (per basis) they were refunded, charged back, cancelled within rule.early_cancel_days days, or opened many support tickets. A customer's account reads only its own checkout connectors' sales (za-119): a connector reports refunds only, so its basis is [refund] and it has no country rows. Rates are integer basis points; baseline_bp on a row is the REST of the account (the term left out). verdict: finding (an open one-click suggestion to pause the keyword or ad group, or exclude the country; Apply is POST …/findings/{id}/apply, with Undo), owner_locked, held_sample (fewer than rule.min_bad bad customers), held_baseline (the rest of the account has fewer than rule.min_baseline_paid paid customers), held_rate (below rule.rate_factor times the rest). No buyer is ever named. Paged, never capped: total is every term in the report; follow page.next_cursor until page.has_more is false to read them all, in the report's order. A cursor is tied to one day's report — after the next audit re-writes it, an old cursor is a 422, never a page of a different list.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—
cursor (query)stringNoOpaque cursor from a previous page's page.next_cursor.
limit (query)integerNoMaximum items to return (page size).

Response

NameTypeRequiredWhat it is
as_ofstringYes—
totalintegerYesEvery term in the report, across all pages.
pagePageMetaYes—
basisstring<refund, chargeback, early_cancel, support>[]Yes—
paidintegerYesPaid customers an advert term acquired.
badintegerYes—
baseline_bpintegerYesThe whole account's bad-customer rate, basis points.
ruleobjectYes—
dataAdsAcquisitionQualityRow[]Yes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429