Get clicks by link
/emails/metrics/linksAuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
start_datestringend_datestringdomain_idstring<uuid>[]broadcast_idstring<uuid>[]limitintegerLinks to list, 1-100 (default 20)
Clicks in the range by the link that was clicked, most clicked first (BillionSend extension). A link is counted as its scheme, host and path: the query string and fragment are left out, so a link personalised per recipient is one row. clicked counts people; bot_clicked counts fetches by machines such as security scanners and link previews. Counts cover whole UTC hours like GET /emails/metrics, and clicks are counted by link from 2026-11-16 on. A key held to one domain always reads that domain only.
objectstringobligatorioliststart_datestringobligatorioend_datestringobligatoriohas_morebooleanobligatoriodataobject[]obligatorioMostrar propiedadesOcultar propiedades
objectlinkstringobligatorioScheme, host and path of the clicked URL
clickedintegerobligatorioClicks by people
bot_clickedintegerobligatorioFetches by machines (security scanners, link previews)
Missing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioRestricted API key: a sending_access key, or a key held to one domain that named another domain in domain_id
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioValidation error
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioThe statistics store is not answering; sending is unaffected. Retry shortly.
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio