跳到内容
Esc
↑↓导航↵打开⌘J预览

Get clicks by link

GET/emails/metrics/links
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

查询参数
start_datestring
end_datestring
domain_idstring<uuid>[]
最多 100 项
broadcast_idstring<uuid>[]
最多 100 项
limitinteger

Links to list, 1-100 (default 20)

最小值 1 · 最大值 100
响应
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.

objectstring必填
允许值:list
start_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)

401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

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

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
503

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

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求
curl -X GET 'https://api.billionsend.com/emails/metrics/links' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "object": "list",
  "start_date": "string",
  "end_date": "string",
  "has_more": true,
  "data": [
    {
      "link": "string",
      "clicked": 0,
      "bot_clicked": 0
    }
  ]
}

这个页面有帮助吗?