API Reference
Overview
The public /client REST API — read your campaigns, missions and performance.
This reference documents the public /client REST API. The endpoint pages
below are generated directly from the OpenAPI specification, so parameters,
schemas, responses and the interactive "try it" panel always match the spec.
Authentication
Every request is authenticated with a client key sent as a Bearer token:
curl https://developer-api.oppizi.com/client/campaigns \
-H "Authorization: Bearer YOUR_CLIENT_KEY"See the Authentication guide for full details.
Response envelope
List endpoints return a consistent envelope:
{
"success": true,
"data": {
"nodes": [],
"totalCount": 0
}
}Endpoints
- Campaigns — list your campaigns, fetch one, and read its performance.
- Missions — list the missions that make up a campaign.
- Tracking — record and retrieve custom events (conversions, purchases, business metrics).
Everything is served by the developer API at https://developer-api.oppizi.com and
authenticated with the same client key. Pick an endpoint from the sidebar to see
full request and response details.