Get opens and clicks by country
/emails/metrics/countriesAuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
start_datestringend_datestringdomain_idstring<uuid>[]broadcast_idstring<uuid>[]Opens and clicks in the range by the country the reader's address is registered in, most engaged first (BillionSend extension). country is an ISO 3166-1 alpha-2 code, or unknown when the address cannot be placed or the fetch came through a mail provider's image proxy (Gmail, Yahoo, Apple Mail Privacy Protection), whose address is the provider's, not the reader's. Only the country is kept, never the address. People's opens and clicks are counted apart from machines' (bot_opened, bot_clicked). Counts cover whole UTC hours like GET /emails/metrics, and opens and clicks are counted by country from 2026-11-16 on. IP geolocation by DB-IP (db-ip.com), CC BY 4.0. A key held to one domain always reads that domain only.
objectstringobrigatórioliststart_datestringobrigatórioend_datestringobrigatóriohas_morebooleanobrigatóriodataobject[]obrigatórioMostrar propriedadesOcultar propriedades
objectcountrystringobrigatórioISO 3166-1 alpha-2 code, or unknown
openedintegerobrigatórioOpens by people
unique_openedintegerobrigatórioEmails whose first open came from here
bot_openedintegerobrigatórioPixel fetches by machines (scanners, prefetches)
clickedintegerobrigatórioClicks by people
unique_clickedintegerobrigatórioEmails whose first click came from here
bot_clickedintegerobrigatórioLink fetches by machines
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