Retrieve Broadcast Metrics
Retrieve aggregate metrics for a broadcast.
GET
Delivery and engagement counters for a single broadcast. Each counter reports a
total (the number of recipients) and a percentage. Opens and clicks are
reported as unique counts.
While a broadcast is still sending, percentages divide by the number of emails
sent so far (delivered + bounced). Once the broadcast has finished, they
divide by the full audience total. Suppressions are decided before sending, so
they always divide by the full audience total.
Responses are cached for up to 15 minutes, so requesting the same broadcast’s
metrics again may return slightly stale data within that window.
Path Parameters
Response Fields
string
Always
broadcast_metrics.string
The broadcast’s ID.
string
The broadcast’s status. See all available
status types in the Broadcasts
overview.string
When the broadcast was created.
string | null
When the broadcast is or was scheduled to send.
null if it was never
scheduled.string | null
When the broadcast started sending.
null if it hasn’t started.number
The total number of recipients in the broadcast’s audience.
number
The total number of recipients processed so far. Calculated as
delivered + bounced.number
The total number of recipients not yet processed. Calculated as
total minus
sent minus suppressed, floored at 0.object
The total number and percentage of emails accepted by the recipient’s mail
server. Shaped as
{ total, percentage }.object
The total number and percentage of recipients who opened, counted once
per recipient. Shaped as
{ total, percentage }.object
The total number and percentage of recipients who clicked, counted once
per recipient. Shaped as
{ total, percentage }.object
The total number and percentage of recipients who unsubscribed. Shaped as
{ total, percentage }.object
The total number and percentage of emails that bounced. Shaped as
{ total, percentage }.object
The total number and percentage of emails marked as spam by the recipient.
Shaped as
{ total, percentage }.object
The total number and percentage of emails not sent because the recipient
was suppressed. Shaped as
{ total, percentage }.array
Every link that was clicked, with per-link counts.