OppiziDeveloper
API ReferencePerformance

Analytics views

GET
/client/campaigns/{id}/analytics/{slug}

A focused analytics view of the campaign.

slug picks which one:

  • overview — volume over time
  • by-week, by-city — results per period or per area
  • ab-test — how each flyer variant performed
  • timeline — distribution progress
  • creative — performance by artwork

Your own revenue, ROI, CPA and spend figures are included where they are available.

Authorization

ClientBearer
AuthorizationBearer <token>

Client-scoped key as a Bearer JWT; always pinned to your own client.

In: header

Path Parameters

id*string

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

slug*string

Analytics view: overview | by-week | by-city | timeline | creative | ab-test.

Response Body

application/json

curl -X GET "https://example.com/client/campaigns/string/analytics/string"
{  "success": true,  "data": {    "xAxis": {      "label": "Week",      "data": [        "2026-W20",        "2026-W21"      ]    },    "yAxis": {      "scans": {        "label": "Scans",        "data": [          120,          145        ]      },      "conversions": {        "label": "Conversions",        "data": [          18,          22        ]      },      "flyersDistributed": {        "label": "Flyers Distributed",        "data": [          20000,          25000        ]      }    }  }}
Empty
Empty
Empty
Empty
Empty

Campaign performance over time GET

How the campaign is doing over time: flyers distributed, scans and conversions bucketed into periods, alongside your own revenue, ROI, CPA, spend and conversion value.

QR scan analytics GET

Scan activity for the campaign: unique scans, scan conversion rate, how many flyers went out, distribution progress and the average gap between scans.