Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get clicks by link

GET/emails/metrics/links
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Query parameters
start_datestring
end_datestring
domain_idstring<uuid>[]
max items 100
broadcast_idstring<uuid>[]
max items 100
limitinteger

Links to list, 1-100 (default 20)

min 1 · max 100
Responses
200

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.

objectstringrequired
Allowed:list
start_datestringrequired
end_datestringrequired
has_morebooleanrequired
dataobject[]required
Show properties
Array of object
linkstringrequired

Scheme, host and path of the clicked URL

clickedintegerrequired

Clicks by people

bot_clickedintegerrequired

Fetches by machines (security scanners, link previews)

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Restricted API key: a sending_access key, or a key held to one domain that named another domain in domain_id

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
503

The statistics store is not answering; sending is unaffected. Retry shortly.

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/emails/metrics/links' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "start_date": "string",
  "end_date": "string",
  "has_more": true,
  "data": [
    {
      "link": "string",
      "clicked": 0,
      "bot_clicked": 0
    }
  ]
}

Was this page helpful?