Broadcasts
GET
Get Broadcast Statistics
GET /v1/broadcasts/{broadcastId}/statsRetrieve aggregate statistics and performance metrics for a specific broadcast.
Use Cases:
- Monitor broadcast performance in real-time
- Generate campaign reports
- Track deliverability and engagement metrics
- Compare broadcast performance over time
Statistics Included:
Recipients:
total- Total recipients queued for this broadcastqueued- Recipients still waiting to be sentsent- Recipients where email was sent to MTAdelivered- Successfully delivered emailsbounced- Bounced emails (hard and soft)complained- Spam complaints receivedfailed- Permanent delivery failuresunsubscribed- Recipients who unsubscribed from this broadcast
Engagement Metrics:
opened- Total unique opensclicked- Total unique clicksopenRate- Percentage of delivered emails that were opened (0-1)clickRate- Percentage of delivered emails that were clicked (0-1)clickToOpenRate- Percentage of opened emails that were clicked (0-1)
Deliverability Metrics:
deliveryRate- Percentage of sent emails that were delivered (0-1)bounceRate- Percentage of sent emails that bounced (0-1)complaintRate- Percentage of delivered emails that received complaints (0-1)
Data Availability:
The detailsPruned flag indicates whether individual send records are still available:
false- Full send details available via /sends endpointtrue- Send details pruned (after 60 days), only aggregate stats remain
Required Scope: read:broadcasts
Path parameters
broadcastIdstringrequiredUnique identifier for the broadcast
Response
200Broadcast statistics retrieved successfully
objectstringrequiredbroadcastIdstringrequiredrecipientsobjectrequiredengagementobjectrequireddeliverabilityobjectrequireddetailsPrunedbooleanrequired