Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Get opens and clicks by country

GET/emails/metrics/countries
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Query-Parameter
start_datestring
end_datestring
domain_idstring<uuid>[]
max. 100 Elemente
broadcast_idstring<uuid>[]
max. 100 Elemente
Antworten
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.

objectstringerforderlich
Erlaubt:list
start_datestringerforderlich
end_datestringerforderlich
has_morebooleanerforderlich
dataobject[]erforderlich
Eigenschaften anzeigen
Array von object
countrystringerforderlich

ISO 3166-1 alpha-2 code, or unknown

openedintegererforderlich

Opens by people

unique_openedintegererforderlich

Emails whose first open came from here

bot_openedintegererforderlich

Pixel fetches by machines (scanners, prefetches)

clickedintegererforderlich

Clicks by people

unique_clickedintegererforderlich

Emails whose first click came from here

bot_clickedintegererforderlich

Link fetches by machines

401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
503

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/emails/metrics/countries' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "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
    }
  ]
}

War diese Seite hilfreich?