Get email metrics
Delivery statistics for a date range, by period, domain, email or broadcast: counts and rates for sent, delivered, bounced, complained, opened and clicked. Needs a full access key.
/emails/metricsAuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
start_datestringend_datestringtimezonestringgranularitystringhourlydailyweeklymonthlymetricsstring[]dimensionsstring[]domain_idstring<uuid>[]email_idstring<uuid>[]broadcast_idstring<uuid>[]Email metrics for the range, as totals and, when dimensions are given, one row per combination. Counts come from statistics written within seconds of the events; received is the accepted-for-sending count and is left out of answers scoped or broken down by domain, broadcast or email. Rates are percentages. Counts cover whole UTC hours: start_date is floored to its hour, the whole hour of end_date counts, and the response shows the start used. Dates before 1970 read as 1970. timezone must be an IANA name such as Europe/Berlin or UTC, not a UTC offset. sent counts recipients, like delivered, bounced and complained, so the rates stay at or under 100%. email rows list up to 1,000 emails created in the range when no email_id is given. A key held to one domain always reads that domain only.
objectstringrequismetricsstart_datestringrequisend_datestringrequismetricsstring[]requisdimensionsstring[]requisgranularitystringrequishourlydailyweeklymonthlytotalsobjectrequisdataobject[]Missing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequisRestricted API key: a sending_access key, or a key held to one domain that named another domain in domain_id
statusCodenumberrequisnamestringrequismessagestringrequisValidation error
statusCodenumberrequisnamestringrequismessagestringrequisOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequisThe statistics store is not answering; sending is unaffected. Retry shortly.
statusCodenumberrequisnamestringrequismessagestringrequis