ads

GET /v1/ads/connections/{connection_id}/profit

Profit bidding (POAS) — value basis, product costs, fee estimates and the margin sent.

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}/profit \
  -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 (docs/1006 §68, za-189). With value_basis profit, every checkout sale (Stripe, Paddle, Freemius) uploads to the network as its MARGIN: price minus the tax inside it, the provider's fee (reported by Paddle and Freemius, else the source's estimate), the product's cost (products, in the sale's currency, else default_cost_bp of the price) and any refund — so tROAS optimises profit, not revenue. summary is the last summary.days of checkout sales: revenue against the margin, per currency, and the products sold that have no cost yet. An account on a network other than Google or Microsoft is a 422 refusal.adsconnect.platformNotSupported; a write naming a duplicate or blank product, or another account's checkout source, is a 422 refusal.adsconnect.profitBadSettings (FIX-189).

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Response

NameTypeRequiredWhat it is
connection_idstringYes—
value_basisstring<revenue, profit>Yes—
default_cost_bpintegerYes—
productsAdsProductCost[]Yes—
sourcesAdsProfitSourceFee[]Yes—
summaryobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429