Counters: Rotas
Run Commands
O ponto de entrada único para os contadores da sua conta. Envie de 1 a 20 comandos em uma requisição e receba um resultado por comando.
https://g.sendcorex.com/v1/countersMesmo envelope de Logs e Contacts. Peça os totais, este mês e os últimos 30 dias em uma requisição.
Os erros são reportados por comando. Um comando que falha não interrompe os outros, e o status HTTP continua 200.
Parâmetros do corpo
commandsobject[]obrigatório1 a 20 comandos, executados em ordem. O corpo inteiro pode ter até 1 MB.
commands[].commandstringobrigatórioget_totals,get_month,get_months,get_dailyouget_hourly.commands[].argsobjectopcionalOs argumentos do comando.
commands[].idstringopcionalSeu próprio identificador para o resultado. Padrão: o índice (
"0","1"…).
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/counters',
{
commands: [
{
command: "get_totals",
id: "all"
},
{
command: "get_month",
id: "now"
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);
for (const result of response.data.results) {
if (result.type !== 'SUCCESS') console.error(result.id, result.code, result.message);
else console.log(result.id, result.data);
}Resposta
{
"type": "SUCCESS",
"results": [
{
"command": "get_totals",
"id": "all",
"type": "SUCCESS",
"took_ms": 3,
"data": {
"totals": {
"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
}
}
},
{
"command": "get_month",
"id": "now",
"type": "SUCCESS",
"took_ms": 2,
"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
typeSempre
SUCCESSquando a requisição em si foi aceita.results[].command / id / typeQual comando, seu id (ou o índice), e
SUCCESSouERROR.results[].dataA saída do comando. Só aparece quando
typeéSUCCESS.results[].code / messageO erro. Só aparece quando
typeéERROR.
Autenticação
Use a API key que você cria no dashboard, em Developers → API Keys, com o escopo counters:read.
AuthorizationEnvie
Authorization: <api key>ouAuthorization: Bearer <api key>.counters:readO único escopo de que esta rota precisa. É somente leitura.
Tokens de mailboxO token do webmail não funciona aqui. Ele é rejeitado com
WRONG_CREDENTIAL_TYPE.
O que é contado
Todo emailAPI, SMTP relay e campanhas, tudo junto. Cada email conta uma vez, quando recebe seu resultado final.
Em tempo realOs contadores mudam alguns segundos depois de cada resultado de entrega. Não há processamento diário em lote.
Horas e meses em UTCget_hourlyeget_month(s)usam UTC.get_dailymonta os dias no fuso horário que você pedir.
Rate limits e cache
15 requisições / segundoPor IP + API key. Acima disso você recebe HTTP 429 com
Retry-After.Cache de leitura: 1,5 sO mesmo comando com os mesmos args dentro de 1,5 segundo retorna o mesmo resultado.
Erros
Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.
- 400
INVALID_JSONO corpo não é {"commands":[...]} ou tem mais de 1 MB.
- 400
INVALID_ARGSA requisição não tem comandos ou tem mais de 20.
- 401
MISSING_AUTH_HEADERNenhum header Authorization foi enviado.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 401
API_KEY_EXPIREDA API key passou da data de expiração definida no dashboard.
- 401
WRONG_CREDENTIAL_TYPEFoi enviado um token de mailbox. A Counters API precisa de uma API key do dashboard.
- 403
IP_NOT_ALLOWEDA requisição veio de um IP que não está nos IPs permitidos da key.
- 403
ACCOUNT_BLOCKEDA conta está bloqueada.
- 403
MISSING_SCOPEA key não tem `counters:read`, então nenhum comando pode rodar.
- 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.
- 503
AUTH_UNAVAILABLEA autenticação está temporariamente indisponível. Tente de novo.
- CMD
UNKNOWN_COMMANDO nome do comando não existe.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.