Quickstart
Make your first authenticated Oppizi API request in a couple of minutes.
This guide walks you through your first authenticated request.
1. Get your client key
Your client key is provisioned for you in the Oppizi Ads interface (it is not
created on this docs site). The same key works for both the /client endpoints
and the Tracking API. Keep it somewhere safe — an environment variable is ideal:
export OPPIZI_CLIENT_KEY="YOUR_CLIENT_KEY"2. List your campaigns
Call the API with your key in the Authorization header:
curl https://developer-api.oppizi.com/client/campaigns \
-H "Authorization: Bearer $OPPIZI_CLIENT_KEY"You'll get back an envelope with your campaigns:
{
"success": true,
"data": {
"nodes": [
{
"id": "cmp_123",
"name": "Spring flyer drop — Paris",
"status": "ACTIVE",
"type": "HANDTOHAND",
"city": "Paris",
"country": "FR",
"startDate": "2026-03-01",
"endDate": "2026-03-31",
"flyerQuantity": 50000,
"distributed": 42310
}
],
"totalCount": 1
}
}3. Track a conversion
Send an event back to Oppizi when something meaningful happens:
await fetch('https://developer-api.oppizi.com/tracking/events', {
method: 'POST',
headers: new Headers({
'Content-Type': 'application/json',
Authorization: `Bearer ${process.env.OPPIZI_CLIENT_KEY}`,
}),
body: JSON.stringify({
eventName: 'Purchase',
value: 250,
metadata: { orderId: 182394 },
}),
});Next steps
- Explore the full API Reference.
- Read the Tracking and recommended events guides.