Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get email metrics

GET/emails/metrics
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Query parameters
start_datestring
end_datestring
timezonestring
granularitystring
Allowed:hourlydailyweeklymonthly
metricsstring[]
dimensionsstring[]
domain_idstring<uuid>[]
max items 100
email_idstring<uuid>[]
max items 100
broadcast_idstring<uuid>[]
max items 100
Responses
200

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.

objectstringrequired
Allowed:metrics
start_datestringrequired
end_datestringrequired
metricsstring[]required
dimensionsstring[]required
granularitystringrequired
Allowed:hourlydailyweeklymonthly
totalsobjectrequired
dataobject[]
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Restricted API key: a sending_access key, or a key held to one domain that named another domain in domain_id

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
503

The statistics store is not answering; sending is unaffected. Retry shortly.

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/emails/metrics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "metrics",
  "start_date": "string",
  "end_date": "string",
  "metrics": [
    "string"
  ],
  "dimensions": [
    "string"
  ],
  "granularity": "hourly",
  "totals": {
    "property1": 0,
    "property2": 0
  },
  "data": [
    {
      "property1": "string",
      "property2": "string"
    }
  ]
}

Was this page helpful?