Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Get clicks by link

GET/emails/metrics/links
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de consulta
start_datestring
end_datestring
domain_idstring<uuid>[]
máx. 100 itens
broadcast_idstring<uuid>[]
máx. 100 itens
limitinteger

Links to list, 1-100 (default 20)

mín. 1 · máx. 100
Respostas
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.

objectstringobrigatório
Valores permitidos:list
start_datestringobrigatório
end_datestringobrigatório
has_morebooleanobrigatório
dataobject[]obrigatório
Mostrar propriedades
Array de object
linkstringobrigatório

Scheme, host and path of the clicked URL

clickedintegerobrigatório

Clicks by people

bot_clickedintegerobrigatório

Fetches by machines (security scanners, link previews)

401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
503

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Requisição
curl -X GET 'https://api.billionsend.com/emails/metrics/links' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "list",
  "start_date": "string",
  "end_date": "string",
  "has_more": true,
  "data": [
    {
      "link": "string",
      "clicked": 0,
      "bot_clicked": 0
    }
  ]
}

Esta página foi útil?