Counters: Leitura

Obter por dia

Dia a dia no seu fuso horário, para gráficos. Dias sem envios voltam como zero, então a série não tem lacunas.

POSThttps://g.sendcorex.com/v1/counterscommand: get_daily
i

Requer o escopo counters:read na sua API key.

i

Até 400 dias por comando.

Argumentos

  • fromstringobrigatório

    Primeiro dia, YYYY-MM-DD, inclusive, em timezone.

    ex.: "2026-10-01"

  • tostringobrigatório

    Último dia, YYYY-MM-DD, inclusive, em timezone.

    ex.: "2026-10-17"

  • timezonestringopcional

    Um fuso horário IANA. Os limites dos dias o seguem, horário de verão incluído. Padrão: UTC.

    ex.: "America/Sao_Paulo"

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/counters',
  {
    commands: [
      {
        command: "get_daily",
        args: {
          from: "2026-10-01",
          to: "2026-10-17",
          timezone: "Asia/Kuala_Lumpur"
        }
      }
    ]
  },
  { 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_daily",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 18,
      "data": {
        "timezone": "Asia/Kuala_Lumpur",
        "daily": [
          {
            "day": "2026-10-17",
            "delivered": 2104,
            "bounced": 31,
            "blocked": 5,
            "complaints": 1,
            "rate_limited": 4,
            "total": 2144,
            "delivered_rate": 98.13,
            "bounce_rate": 1.45,
            "blocked_rate": 0.23,
            "complaint_rate": 0.05,
            "rate_limited_rate": 0.19
          }
        ],
        "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
        }
      }
    }
  ]
}

Campos da resposta

  • timezone

    O fuso horário em que os dias foram montados.

  • daily

    Uma entrada por dia de from a to, do mais antigo para o mais novo, zeros incluídos. Cada uma tem day (YYYY-MM-DD) e os contadores.

  • totals

    A soma do período.

  • delivered

    Emails que o servidor de destino aceitou.

  • bounced

    Emails 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.

  • blocked

    Emails 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).

  • complaints

    Destinatá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_limited

    Emails que o servidor de destino continuou adiando até as tentativas acabarem.

  • total

    delivered + bounced + blocked + rate_limited: todo email que teve um resultado.

  • delivered_rate / bounce_rate / blocked_rate / complaint_rate / rate_limited_rate

    Cada contador como porcentagem de total, com 2 casas decimais. 0 quando total é 0.

Gráfico dos últimos 30 dias

Node.js

const to = new Date().toISOString().slice(0, 10);
const from = new Date(Date.now() - 29 * 86400_000).toISOString().slice(0, 10);
const [result] = await call({ command: 'get_daily', args: { from, to, timezone: Intl.DateTimeFormat().resolvedOptions().timeZone } });

const labels = result.data.daily.map((d) => d.day);
const delivered = result.data.daily.map((d) => d.delivered);
const bounced = result.data.daily.map((d) => d.bounced);
i

call é qualquer helper que faz POST de { commands: [...] } para /v1/counters e retorna results.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401INVALID_API_KEY

    A API key não existe, foi revogada ou foi desativada no dashboard.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 simultâneas para o mesmo IP + API key. Aguarde o número de segundos em Retry-After.

  • CMDMISSING_SCOPE

    A API key não tem `counters:read`.

  • CMDINVALID_ARGS

    Um 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…

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.