Get clicks by link
/emails/metrics/linksAuthorizationBearer 令牌 · header必填A 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.
objectstring必填liststart_datestring必填end_datestring必填has_moreboolean必填dataobject[]必填显示属性隐藏属性
object 数组linkstring必填Scheme, host and path of the clicked URL
clickedinteger必填Clicks by people
bot_clickedinteger必填Fetches by machines (security scanners, link previews)
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必填