Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

Get opens and clicks by country

GET/emails/metrics/countries
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de consulta
start_datestring
end_datestring
domain_idstring<uuid>[]
máx. 100 elementos
broadcast_idstring<uuid>[]
máx. 100 elementos
Respuestas
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.

objectstringobligatorio
Valores permitidos:list
start_datestringobligatorio
end_datestringobligatorio
has_morebooleanobligatorio
dataobject[]obligatorio
Mostrar propiedades
Array de object
countrystringobligatorio

ISO 3166-1 alpha-2 code, or unknown

openedintegerobligatorio

Opens by people

unique_openedintegerobligatorio

Emails whose first open came from here

bot_openedintegerobligatorio

Pixel fetches by machines (scanners, prefetches)

clickedintegerobligatorio

Clicks by people

unique_clickedintegerobligatorio

Emails whose first click came from here

bot_clickedintegerobligatorio

Link fetches by machines

401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
503

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Solicitud
curl -X GET 'https://api.billionsend.com/emails/metrics/countries' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "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
    }
  ]
}

¿Te ha resultado útil esta página?