Retrieve Metrics
Retrieve account-level email metrics.
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. The date range can’t produce more than 10,000 periods at the
chosen granularity. This limit only applies when period is in dimensions.string[]
List of metrics to include in the response. Defaults to all of the
following:
received, 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
any of
period, domain, email, or broadcast to group the data by
more than one at once, except email cannot be combined with broadcast.
Defaults to [], returning a single totals row for the whole range, with
no data.Possible values:period: groups the data bygranularityperiod, in chronological order.domain: groups the data by sending domain.email: groups the data by email. Cannot be combined withbroadcast.broadcast: groups the data by broadcast. Cannot be combined withemail.
string[]
List of sending domain IDs to restrict the response to, up to 100.
string[]
List of email IDs to restrict the response to, up to 100. Cannot be combined
with the
broadcast dimension or broadcast_id.string[]
List of broadcast IDs to restrict the response to, up to 100. Cannot be
combined with the
email dimension or email_id.