Read Performance & ROI
Pull scans, reach, conversions, CVR, revenue and ROI for a campaign — by week, city and creative — over REST or by asking your AI assistant.
Once a campaign is live, read its results directly from the API — no report building. Three endpoints cover most needs:
- Performance — the headline summary for a campaign.
- Analytics — a breakdown by a named slice (week, city, creative, A/B).
- Scans — raw scan activity and distribution progress.
export OPPIZI_CLIENT_KEY="YOUR_CLIENT_KEY"
export API="https://developer-api.oppizi.com"Performance summary
curl "$API/client/campaigns/cmp_9f21/performance" \
-H "Authorization: Bearer $OPPIZI_CLIENT_KEY"{
"success": true,
"data": {
"scans": 4820,
"reach": 50000,
"conversions": 612,
"cvr": 0.127,
"revenue": 18360,
"roi": 4.3
}
}You get scans, reach, conversions, conversion rate (CVR), and — from the conversions you track — revenue and ROI.
Analytics by slice
analytics/{slug} returns the same metrics broken down by a named dimension.
Common slugs: week, city, creative, ab.
# By week
curl "$API/client/campaigns/cmp_9f21/analytics/week" \
-H "Authorization: Bearer $OPPIZI_CLIENT_KEY"
# By city
curl "$API/client/campaigns/cmp_9f21/analytics/city" \
-H "Authorization: Bearer $OPPIZI_CLIENT_KEY"
# By creative
curl "$API/client/campaigns/cmp_9f21/analytics/creative" \
-H "Authorization: Bearer $OPPIZI_CLIENT_KEY"{
"success": true,
"data": {
"slug": "week",
"rows": [
{
"key": "2026-W31",
"scans": 1210,
"conversions": 150,
"revenue": 4500,
"roi": 3.9
},
{
"key": "2026-W32",
"scans": 1680,
"conversions": 205,
"revenue": 6150,
"roi": 4.6
}
]
}
}Scans
For raw scan activity and distribution progress:
curl "$API/client/campaigns/cmp_9f21/scans" \
-H "Authorization: Bearer $OPPIZI_CLIENT_KEY"This gives unique scans, scan conversion rate, and how much of the campaign has been distributed so far.
Via MCP
Ask your connected assistant in plain language:
"How did my last mail campaign perform — scans, conversions and ROI by week?"
"Which city drove the best ROI on campaign cmp_9f21?"
The assistant pulls performance, analytics and scans for you and summarises them. See Connect Claude or ChatGPT.
Next steps
- Track a conversion so revenue and ROI show up here.
- Browse every field in the API Reference.