OppiziDeveloper
API ReferencePerformance

Your campaign scan analytics

QR/scan analytics for your OWN campaign — unique scans, scan CVR, flyers distributed/inserted, inserting progress and average time between scans. Ownership is checked first (404 if the campaign is not yours). Monetary figures (e.g. cost-per-scan derived from Oppizi hard cost) are dropped. Notes: - The "Scans CPA" (an Oppizi-cost amount) is intentionally dropped. Composed from: ownership check (PG) then the /ai scans upstream, curated to a volume/CVR allowlist

GET
/client/campaigns/{id}/scans

QR/scan analytics for your OWN campaign — unique scans, scan CVR, flyers distributed/inserted, inserting progress and average time between scans. Ownership is checked first (404 if the campaign is not yours). Monetary figures (e.g. cost-per-scan derived from Oppizi hard cost) are dropped.

Notes:

  • The "Scans CPA" (an Oppizi-cost amount) is intentionally dropped.

Composed from: ownership check (PG) then the /ai scans upstream, curated to a volume/CVR allowlist

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

Numeric campaign id (must belong to the calling key’s client).

Response Body

application/json

curl -X GET "https://example.com/client/campaigns/string/scans"
{  "success": true,  "data": {    "quantity": {      "title": "Unique Scans",      "value": 342    },    "cvr": {      "title": "Scans CVR",      "value": 5.1,      "type": "PERCENT"    },    "flyers": {      "title": "Flyers distributed",      "value": 20000    }  }}
Empty
Empty
Empty
Empty
Empty