跳到内容
Esc
↑↓导航↵打开⌘J预览

Get opens and clicks by country

GET/emails/metrics/countries
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

查询参数
start_datestring
end_datestring
domain_idstring<uuid>[]
最多 100 项
broadcast_idstring<uuid>[]
最多 100 项
响应
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.

objectstring必填
允许值:list
start_datestring必填
end_datestring必填
has_moreboolean必填
dataobject[]必填
显示属性
object 数组
countrystring必填

ISO 3166-1 alpha-2 code, or unknown

openedinteger必填

Opens by people

unique_openedinteger必填

Emails whose first open came from here

bot_openedinteger必填

Pixel fetches by machines (scanners, prefetches)

clickedinteger必填

Clicks by people

unique_clickedinteger必填

Emails whose first click came from here

bot_clickedinteger必填

Link fetches by machines

401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

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

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
503

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

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求
curl -X GET 'https://api.billionsend.com/emails/metrics/countries' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "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
    }
  ]
}

这个页面有帮助吗?