Counters: Leitura
Obter mês
Um mês do calendário (UTC). Sem `month`, o atual.
https://g.sendcorex.com/v1/counterscommand: get_monthRequer o escopo counters:read na sua API key.
Argumentos
monthstringopcionalO mês,
YYYY-MM. Padrão: o mês atual em UTC.ex.:
"2026-10"
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/counters',
{
commands: [
{
command: "get_month",
args: {
month: "2026-10"
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);
const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);Resposta
{
"type": "SUCCESS",
"results": [
{
"command": "get_month",
"id": "0",
"type": "SUCCESS",
"took_ms": 18,
"data": {
"month": "2026-10",
"delivered": 48210,
"bounced": 612,
"blocked": 88,
"complaints": 9,
"rate_limited": 140,
"total": 49050,
"delivered_rate": 98.29,
"bounce_rate": 1.25,
"blocked_rate": 0.18,
"complaint_rate": 0.02,
"rate_limited_rate": 0.29
}
}
]
}Campos da resposta
monthO mês,
YYYY-MM.deliveredEmails que o servidor de destino aceitou.
bouncedEmails que não passaram: rejeitados pelo servidor de destino, expirados na fila ou parados antes do envio. O motivo de cada um está em Bounces & Complaints.
blockedEmails que o servidor de destino recusou como spam, por política ou reputação no momento da entrega. O endereço está ok: o problema foi o envio (qualidade da lista, volume, autenticação, conteúdo).
complaintsDestinatários que reportaram seu email como spam depois de recebê-lo: feedback loops (Outlook, Yahoo…) e denúncias de abuso. Não fazem parte de
total, já que esses emails já foram contados como entregues.rate_limitedEmails que o servidor de destino continuou adiando até as tentativas acabarem.
totaldelivered+bounced+blocked+rate_limited: todo email que teve um resultado.delivered_rate / bounce_rate / blocked_rate / complaint_rate / rate_limited_rateCada contador como porcentagem de
total, com 2 casas decimais.0quandototalé0.
Erros
Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 429
RATE_LIMITEDMais de 15 requisições/s ou 15 simultâneas para o mesmo IP + API key. Aguarde o número de segundos em Retry-After.
- CMD
MISSING_SCOPEA API key não tem `counters:read`.
- CMD
INVALID_ARGSUm argumento é inválido: um mês que não é YYYY-MM, um dia que não é YYYY-MM-DD, um fuso horário desconhecido, from depois de to, um intervalo longo demais…
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.