ads

GET /v1/ads/connections/{connection_id}/ai-max

The AI Max for Search guard — expanded searches against keyword-matched ones, their return, and the customer's own rules (za-204).

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}/ai-max \
  -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 §97) — never a network call in the request. Google reports which door each search came through (segments.search_term_match_source): expanded sums AI_MAX_BROAD_MATCH and AI_MAX_KEYWORDLESS, keyword is ADVERTISER_PROVIDED_KEYWORD. An expanded search's waste is judged by the za-99 negatives path with the customer's own rules (waste_min_clicks, waste_min_cost_minor in minor units of the account currency) and the collision replay; waste_terms lists those findings (Apply / Dismiss are the ordinary POST …/findings/{id}/{action}). return_pct is the expanded searches' conversion value per unit of cost (basis: value) — or conversions per unit of cost (basis: conversions) when no value is recorded — as a percent of the keyword searches'. verdict: none (no AI Max traffic), learning (fewer than rules.compare_min_clicks clicks in either group), no_keyword_return, ok, below (under rules.min_return_pct). skipped: notInGoodStanding or readRefused.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Response

NameTypeRequiredWhat it is
as_ofstringYes—
currencystringYes—
skippedstring<, notInGoodStanding, readRefused>Yes—
expandedAdsAiMaxFiguresYes—
keywordAdsAiMaxFiguresYes—
verdictstring<none, learning, no_keyword_return, ok, below>Yes—
basisstring<, value, conversions>Yes—
return_pctintegerYes—
campaignsAdsAiMaxCampaign[]Yes—
waste_termsobject[]Yes—
rulesAdsAiMaxRulesYes—
ownstring[]YesThe rules the customer set (the rest are Recommended).
recommendedAdsAiMaxRulesYes—
boundsobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 429