Get opens by mail client
/emails/metrics/clientsAuthorizationBearer 令牌 · header必填A BillionSend API key (bs_…).
start_datestringend_datestringdomain_idstring<uuid>[]broadcast_idstring<uuid>[]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.
objectstring必填liststart_datestring必填end_datestring必填has_moreboolean必填dataobject[]必填显示属性隐藏属性
object 数组clientstring必填The mail client that fetched the open
gmailapple_mailoutlookyahoothunderbirdotherunknownopenedinteger必填Opens by people
unique_openedinteger必填Emails whose first open came from here
bot_openedinteger必填Pixel fetches by machines (scanners, prefetches)
Missing, malformed, unknown or revoked API key
statusCodenumber必填namestring必填messagestring必填Restricted API key: a sending_access key, or a key held to one domain that named another domain in domain_id
statusCodenumber必填namestring必填messagestring必填Validation error
statusCodenumber必填namestring必填messagestring必填Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumber必填namestring必填messagestring必填The statistics store is not answering; sending is unaffected. Retry shortly.
statusCodenumber必填namestring必填messagestring必填