Get opens by mail client
/emails/metrics/clientsAuthorizationToken Bearer · headerobrigatórioA 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.
objectstringobrigatórioliststart_datestringobrigatórioend_datestringobrigatóriohas_morebooleanobrigatóriodataobject[]obrigatórioMostrar propriedadesOcultar propriedades
objectclientstringobrigatórioThe mail client that fetched the open
gmailapple_mailoutlookyahoothunderbirdotherunknownopenedintegerobrigatórioOpens by people
unique_openedintegerobrigatórioEmails whose first open came from here
bot_openedintegerobrigatórioPixel fetches by machines (scanners, prefetches)
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioRestricted API key: a sending_access key, or a key held to one domain that named another domain in domain_id
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioValidation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioThe statistics store is not answering; sending is unaffected. Retry shortly.
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório