Análises
Estatísticas de entrega poucos segundos após cada evento, no painel e por GET /emails/metrics.
Cada resultado (entregue, bounce, reclamação, aberto, clicado, descadastrado) é contado poucos segundos depois de acontecer. A página Análises do painel e GET /emails/metrics leem os mesmos números.
No painel, Análises mostra as taxas de entrega, abertura, cliques, bounce e reclamação e um gráfico de eventos por hora. Você pode filtrar por período (7, 15 ou 30 dias), fuso horário, marca (domínio de envio), transmissão e domínio do destinatário.
As estatísticas são guardadas por hora durante 13 meses. O histórico de uma transmissão não é cortado aos 13 meses. Se o serviço de estatísticas não responder, o endpoint retorna 503 service_unavailable e o envio não é afetado. As listas de e-mails, as exportações e os eventos de um e-mail não são estatísticas; veja Logs.
Pedir os números
GET /emails/metrics exige uma chave de API de acesso total. Os SDKs o chamam como emails.metrics().
curl "https://api.billionsend.com/emails/metrics?start_date=2026-11-01&end_date=2026-11-14&granularity=daily&metrics=sent&metrics=delivered&metrics=open_rate&dimensions=period" \
-H "Authorization: Bearer bs_..."
| Parâmetro | O que faz |
|---|---|
start_date, end_date |
O intervalo. As estatísticas são lidas em horas UTC inteiras, e a resposta mostra o início usado. |
timezone |
Um nome de fuso IANA, como America/Sao_Paulo (um deslocamento UTC como +05:00 não é aceito). Os períodos são cortados nesse fuso. |
granularity |
hourly, daily, weekly ou monthly: o tamanho de um período quando dimensions inclui period. Um intervalo pode ter no máximo 10.000 períodos. |
metrics |
Repita para cada métrica que você quer (veja abaixo). |
dimensions |
Repita para cada detalhamento: period, domain, email ou broadcast. email e broadcast não podem ser combinados. |
domain_id, email_id, broadcast_id |
Filtros. Repita cada um até 100 vezes. |
A resposta tem totals para o intervalo inteiro e, quando você pede dimensões, uma linha por combinação em data.
Métricas
| Métrica | Conta |
|---|---|
received |
Destinatários aceitos para envio. Não pertence a nenhum domínio, transmissão ou e-mail, então uma resposta filtrada ou detalhada por um deles a deixa de fora. |
sent, delivered, delivery_delayed, failed, suppressed |
Destinatários, por resultado do envio. |
bounced, bounced_permanent, bounced_transient, bounced_undetermined |
Bounces e as três classes de bounce. |
complained, unsubscribed |
Reclamações de spam e destinatários que saíram pelo link de descadastro. |
opened, clicked |
Cada abertura e cada clique. |
unique_opened, unique_clicked |
E-mails abertos ou clicados ao menos uma vez. |
delivery_rate |
delivered ÷ sent |
bounce_rate |
bounced ÷ sent |
open_rate, click_rate |
unique_opened ou unique_clicked ÷ delivered |
complaint_rate, unsubscribe_rate |
complained ou unsubscribed ÷ delivered |
As taxas são porcentagens com uma casa decimal, e 0 quando não há o que dividir. Aberturas e cliques feitos por máquinas, como proxies de privacidade e scanners de segurança, não contam como aberturas nem como cliques.
Com a dimensão email e sem email_id, a resposta lista até 1.000 e-mails criados no intervalo.
Cliques por link
GET /emails/metrics/links (uma extensão do BillionSend, chave de acesso total) lista os links que as pessoas clicaram em um período, do mais clicado para o menos:
curl "https://api.billionsend.com/emails/metrics/links?start_date=2026-11-01&end_date=2026-11-14&limit=10" \
-H "Authorization: Bearer bs_..."
{
"object": "list",
"start_date": "2026-11-01T00:00:00.000Z",
"end_date": "2026-11-14T23:59:59.999Z",
"has_more": false,
"data": [
{ "link": "https://shop.example.com/sale", "clicked": 412, "bot_clicked": 37 }
]
}
- Um link conta pelo esquema, host e caminho. A query string e o fragmento ficam de fora, então um link personalizado para cada destinatário é uma linha só e nenhum dado de destinatário é guardado.
clickedconta pessoas;bot_clickedconta acessos de máquinas, como scanners de segurança e prévias de link.- Aceita
start_date,end_date,domain_id,broadcast_id(separados por vírgula) elimit(1 a 100, padrão 20), e cobre horas UTC inteiras comoGET /emails/metrics. Os cliques são contados por link a partir de 16 de novembro de 2026.
Aberturas e cliques por país e cliente de e-mail
GET /emails/metrics/countries lista as aberturas e cliques de pessoas pelo país de onde vieram, e GET /emails/metrics/clients lista as aberturas pelo cliente de e-mail que carregou as imagens (ambos extensões da BillionSend, chave de acesso total), dos mais engajados para os menos:
curl "https://api.billionsend.com/emails/metrics/countries?start_date=2026-11-16&end_date=2026-11-30" \
-H "Authorization: Bearer bs_..."
{
"object": "list",
"start_date": "2026-11-16T00:00:00.000Z",
"end_date": "2026-11-30T23:59:59.999Z",
"has_more": false,
"data": [
{ "country": "BR", "opened": 1840, "unique_opened": 1203, "bot_opened": 95, "clicked": 311, "unique_clicked": 240, "bot_clicked": 22 },
{ "country": "unknown", "opened": 960, "unique_opened": 702, "bot_opened": 410, "clicked": 12, "unique_clicked": 9, "bot_clicked": 3 }
]
}
countryé o código ISO 3166-1 alfa-2 do país em que o endereço do leitor está registrado. Éunknownquando o endereço não pode ser localizado, e nas aberturas pelos proxies de imagem do Gmail e do Yahoo ou pela Proteção de Privacidade do Apple Mail: essas vêm do endereço do provedor, não do leitor.clienté um degmail,apple_mail,outlook,yahoo,thunderbird,other(um navegador: webmail e clientes que não se identificam parecem iguais) ouunknown(sem user agent). Cliques não são contados por cliente, porque um clique chega do navegador para o qual o cliente de e-mail passa o link.- Para as estatísticas só se guardam o país e o cliente, nunca o endereço nem o user agent.
unique_openedeunique_clickedcontam os e-mails cuja primeira abertura ou primeiro clique veio daquele país ou cliente. Pessoas e máquinas são contadas à parte, como emGET /emails/metrics.- Os dois aceitam
start_date,end_date,domain_idebroadcast_id(separados por vírgula), cobrem horas UTC inteiras e devolvem todas as linhas (países e clientes são poucos). Aberturas e cliques são contados por país e cliente a partir de 16 de novembro de 2026. - Geolocalização de IP por DB-IP, sob licença CC BY 4.0.
Relacionado
O Deliverability Insights dá uma nota a cada e-mail e à sua conta. Para reagir a um resultado assim que ele acontece, em vez de contá-lo depois, use webhooks.