To see how your campaign is performing in the real world, you query the Report endpoint. This is Step 17 of the procedure: "Obtaining playout statistics."
Monitoring Real-Time Performance
This GET request provides a summary of your spending and the specific metrics (Plays, Impressions, or Views) based on your chosen payment model.
Endpoint Structure:
GET https://api.dooh.one/api/v2/agency/{YOUR_AGENCY_ID}/dsp/request/{REQUEST_ID}/report/
Example Command (cURL)
Bash
curl -i -X GET \
-H 'x-authorization: Bearer <access_token>' \
-H 'x-adexchange-role: dsp' \
'https://api.dooh.one/api/v2/agency/2/dsp/request/317/report/'
Understanding the Report Data
The response gives you a snapshot of your campaign’s lifecycle.
JSON
{
"campaign_id": 317,
"name": "flash_sale_campaign",
"currency": "USD",
"total_spent": 45.25,
"statistics": {
"plays": {
"count": 450,
"cost": 45.25
},
"impressions": {
"count": 12000,
"cost": 0.0
}
},
"period": {
"start": "2024-05-20T00:00:00Z",
"end": "2024-05-20T23:59:59Z"
}
}
Key Metrics to Track
Plays (
count): The actual number of times your video was shown on a screen. If you are using thead_playspayment model, this is what you are billed for.Impressions: The estimated number of people who saw the ad (audience reach).
Total Spent: Your current expenditure. If this approaches your
budgetlimit, the campaign will automatically transition tocompleted.
The Complete Integration Flow
To wrap everything up for a new customer, here is the full journey from a technical perspective:
| Phase | Action | Endpoint |
|---|---|---|
| Setup | Get Token | /login/token/ |
| Planning | Create Draft | /dsp/request/ |
| Creative | Upload File | /dsp/ad/ |
| Review | Check Audit | /dsp/ad/{id}/ |
| Launch | Set Active | /dsp/request/{id}/ (PATCH) |
| Analysis | Get Stats | /dsp/request/{id}/report/ |
Comments
0 comments
Please sign in to leave a comment.