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

Get opens and clicks by country

GET/emails/metrics/countries
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
Respostas
200

Opens and clicks in the range by the country the reader's address is registered in, most engaged first (BillionSend extension). country is an ISO 3166-1 alpha-2 code, or unknown when the address cannot be placed or the fetch came through a mail provider's image proxy (Gmail, Yahoo, Apple Mail Privacy Protection), whose address is the provider's, not the reader's. Only the country is kept, never the address. People's opens and clicks are counted apart from machines' (bot_opened, bot_clicked). Counts cover whole UTC hours like GET /emails/metrics, and opens and clicks are counted by country from 2026-11-16 on. IP geolocation by DB-IP (db-ip.com), CC BY 4.0. 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
countrystringobrigatório

ISO 3166-1 alpha-2 code, or unknown

openedintegerobrigatório

Opens by people

unique_openedintegerobrigatório

Emails whose first open came from here

bot_openedintegerobrigatório

Pixel fetches by machines (scanners, prefetches)

clickedintegerobrigatório

Clicks by people

unique_clickedintegerobrigatório

Emails whose first click came from here

bot_clickedintegerobrigatório

Link fetches by machines

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/countries' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "list",
  "start_date": "string",
  "end_date": "string",
  "has_more": true,
  "data": [
    {
      "country": "string",
      "opened": 0,
      "unique_opened": 0,
      "bot_opened": 0,
      "clicked": 0,
      "unique_clicked": 0,
      "bot_clicked": 0
    }
  ]
}

Esta página foi útil?