Campaigns API
Access promoted content and track campaign performance
Get Campaign Content
POST
/tools/get-campaign-content
Retrieve promoted/sponsored content relevant to user queries. Use this to surface advertisements in AI responses.
Example Request
curl -X POST "https://opttab.com/api/v1/ai/tools/get-campaign-content" \
-H "X-API-Key: opttab_abc123..." \
-H "X-API-Secret: your-secret-here" \
-H "Content-Type: application/json" \
-d '{
"keywords": ["technology", "ai", "innovation"],
"target_audience": "developers",
"limit": 10
}'
Update Campaign Metrics
POST
/campaigns/metrics
Report campaign performance metrics (impressions, clicks, conversions) back to Opttab.
Example Request
curl -X POST "https://opttab.com/api/v1/ai/campaigns/metrics" \
-H "X-API-Key: opttab_abc123..." \
-H "X-API-Secret: your-secret-here" \
-H "Content-Type: application/json" \
-d '{
"campaign_id": 789,
"ai_model": "gpt-4",
"impressions": 1000,
"clicks": 45,
"conversions": 8,
"spent": 125.50
}'
Best Practices
Track All Impressions
Report metrics accurately for transparency. Update metrics at least daily.
Relevance Matching
Only show campaigns that are truly relevant to user queries for better user experience.