Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get opens by mail client

GET/emails/metrics/clients
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Query parameters
start_datestring
end_datestring
domain_idstring<uuid>[]
max items 100
broadcast_idstring<uuid>[]
max items 100
Responses
200

Opens in the range by the mail client that fetched the message's images, most opened first (BillionSend extension). client is one of gmail, apple_mail, outlook, yahoo, thunderbird, other (a web browser, which webmail and clients without markers look like) or unknown (no user agent). Clicks are not counted by client: a click arrives from the browser the client hands the link to. Only the client is kept, never the user agent. Counts cover whole UTC hours like GET /emails/metrics, and opens are counted by client from 2026-11-16 on. A key held to one domain always reads that domain only.

objectstringrequired
Allowed:list
start_datestringrequired
end_datestringrequired
has_morebooleanrequired
dataobject[]required
Show properties
Array of object
clientstringrequired

The mail client that fetched the open

Allowed:gmailapple_mailoutlookyahoothunderbirdotherunknown
openedintegerrequired

Opens by people

unique_openedintegerrequired

Emails whose first open came from here

bot_openedintegerrequired

Pixel fetches by machines (scanners, prefetches)

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/clients' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "start_date": "string",
  "end_date": "string",
  "has_more": true,
  "data": [
    {
      "client": "gmail",
      "opened": 0,
      "unique_opened": 0,
      "bot_opened": 0
    }
  ]
}

Was this page helpful?