API ReferenceCampaigns
Get campaign performance
Returns distribution and engagement performance for a campaign. No cost, revenue or margin fields are exposed on the public API.
Returns distribution and engagement performance for a campaign. No cost, revenue or margin fields are exposed on the public API.
Authorization
clientKey AuthorizationBearer <token>
Your Oppizi client key. Send it as Authorization: Bearer <client-key>. Scoped to your client account only.
In: header
Path Parameters
id*string
The campaign id.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/client/campaigns/string/performance"{ "success": true, "data": { "distributed": 42310, "scans": 2874, "reach": 38100, "conversions": 512, "timeline": [ { "date": "2026-03-04", "distributed": 3200, "scans": 210 } ] }}{ "success": false, "error": "Unauthorized"}{ "success": false, "error": "Unauthorized"}Get a campaign GET
Returns a single campaign owned by your client account.
Get campaign coupons GET
Lists the flyer/promo codes for your campaign. Each row's `code` is the value to send as `coupon` when recording a tracking event. Scoped to your client — a campaign that is not yours returns an empty page.