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.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[]
Comma-separated 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:"[]"
Comma-separated list of dimensions to break the response down by. Combine
period with domain or email for a joint breakdown (one row per unique
period + domain/email pair). Defaults to [], returning a single
totals row for the whole range, with no data.Possible values:period: one row pergranularityperiod, zero-filled for periods with no activity. Only zero-filled whenperiodis the only requested dimension.domain: one row per sending domain. Cannot be combined withemail.email: one row per email. Cannot be combined withdomain.
string[]
Comma-separated list of sending domain IDs to restrict the response to.
Unrecognized query params are ignored rather than rejected.
string[]
Comma-separated list of email IDs to restrict the response to. Cannot be
combined with the
domain dimension. Unrecognized query params are ignored
rather than rejected.string
What to sort
data by. Defaults to date when dimensions includes
period, or sent when dimensions is exactly domain or exactly email.Possible values:date: chronological order. Requiresdimensionsto includeperiod.- Any metric:
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_rate. Requiresdimensionsto be exactlydomainor exactlyemail, and must also be included inmetrics.
asc | desc
The sort direction for
sort_by. Defaults to asc when dimensions includes
period, desc otherwise.