Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Get opens and clicks by country

GET/emails/metrics/countries
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de requête
start_datestring
end_datestring
domain_idstring<uuid>[]
max 100 éléments
broadcast_idstring<uuid>[]
max 100 éléments
Réponses
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.

objectstringrequis
Valeurs autorisées :list
start_datestringrequis
end_datestringrequis
has_morebooleanrequis
dataobject[]requis
Afficher les propriétés
Tableau de object
countrystringrequis

ISO 3166-1 alpha-2 code, or unknown

openedintegerrequis

Opens by people

unique_openedintegerrequis

Emails whose first open came from here

bot_openedintegerrequis

Pixel fetches by machines (scanners, prefetches)

clickedintegerrequis

Clicks by people

unique_clickedintegerrequis

Emails whose first click came from here

bot_clickedintegerrequis

Link fetches by machines

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

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

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
503

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
curl -X GET 'https://api.billionsend.com/emails/metrics/countries' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "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
    }
  ]
}

Cette page vous a-t-elle été utile ?