Retrieve Metrics
Retrieve account-wide broadcast metrics, aggregated across all broadcasts.
GET
Metrics are retained according to your plan’s data retention window.
Requesting a
start_date older than your retention window returns data
clamped to the oldest date your plan retains. This doesn’t apply when
broadcast_id is set.Responses are cached for up to 15 minutes, so a request for the same range may
return slightly stale data within that window.
Query Parameters
string
The start of the date range, as an ISO 8601 date (
2026-07-01) or datetime
(2026-07-01T00:00:00Z). Must be on or before end_date. Defaults to 6 days
before end_date.string
The end of the date range, as an ISO 8601 date or datetime. Values in the
future are clamped to the current time. Defaults to now.
string
default:"UTC"
The IANA timezone (e.g.
America/New_York) used to bucket periods when
period is in dimensions.hourly | daily | weekly | monthly
default:"daily"
The bucket size used when
period is in dimensions. Accepted but has no
effect otherwise.string[]
List of metrics to include in the response. Defaults to all of the
following:
delivered, complained, suppressed, bounced, bounced_transient,
bounced_permanent, bounced_undetermined, opened, clicked,
unsubscribed, delivery_delayed, failed, sent, unique_opened,
unique_clicked, delivery_rate, open_rate, click_rate, bounce_rate,
complaint_rate, unsubscribe_ratestring[]
default:"[]"
List of dimensions to break the response down by. Combine
period with broadcast for a joint breakdown (one row per unique periodbroadcastpair). Defaults to[], returning a singletotalsrow for the whole range, with nodata.
period: one row pergranularityperiod, in chronological order.broadcast: one row per broadcast, including itsnameresolved from your account.
string[]
List of broadcast IDs to restrict the response to, up to 100.