To help you further understand the DISPL Ads External DSP API, another important JSON interaction to learn is the Campaign Summary Report.
Once a campaign is active or completed, obtaining a summary of the playout is the final step (Step 17) of the general operational procedure1. This allows you to programmatically receive bidding progress and performance reports.
Example: Playout Summary Report Response
This JSON structure represents the data you would receive when querying the performance of an advertising campaign.
Endpoint: GET /api/v2/agency/<dsp_agency_id>/dsp/request/<request_id>/report/
{
"campaign_id": 26,
"name": "Test Campaign 1",
"currency": "USD",
"total_spent": 1450.75,
"statistics": {
"plays": {
"count": 12500,
"cost": 850.25
},
"impressions": {
"count": 45000,
"cost": 600.50
},
"views": {
"count": 850,
"cost": 0.0
}
},
"period": {
"start": "2021-03-01T00:00:00Z",
"end": "2021-03-09T23:59:59Z"
}
}
Why This Example is Important for Learning
Financial Reconciliation: The
total_spentandcostfields allow you to track exactly how much of your agency's balance has been utilized. This is vital because if a balance falls to zero or below, campaigns are immediately excluded from the auction.Performance Metrics: The
statisticsobject breaks down the data based on different payment models—plays(impressions),impressions(reach/audience), andviews(guaranteed target audience views).Goal Tracking: The campaign automatically ends when goals for plays, scope, budget, or time are reached. This JSON structure helps you monitor how close you are to those limits.
Optimization Data: By receiving these reports programmatically, a DSP can decide whether to adjust the
max_bidor other campaign parameters to improve performance in future auctions.
Understanding this report structure enables you to close the loop on the advertising lifecycle, providing the data necessary for both billing and strategic analysis of your Digital Out-of-Home (DOOH) efforts.
Comments
0 comments
Please sign in to leave a comment.