Counters: Leitura

Obter por hora

Hora a hora (UTC), para ver como um envio está indo agora. Só horas com envios são listadas.

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

Requer o escopo counters:read na sua API key.

i

Até 7 dias por comando.

Argumentos

  • fromstringobrigatório

    Início, RFC 3339. A hora em que ele cai é incluída.

    ex.: "2026-10-17T00:00:00Z"

  • tostringobrigatório

    Fim, RFC 3339. A hora em que ele cai é incluída.

    ex.: "2026-10-17T23:59:59Z"

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/counters',
  {
    commands: [
      {
        command: "get_hourly",
        args: {
          from: "2026-10-17T00:00:00Z",
          to: "2026-10-17T23:59:59Z"
        }
      }
    ]
  },
  { 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_hourly",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 18,
      "data": {
        "hourly": [
          {
            "hour": "2026-10-17T06:00:00Z",
            "delivered": 182,
            "bounced": 3,
            "blocked": 1,
            "complaints": 0,
            "rate_limited": 0
          }
        ]
      }
    }
  ]
}

Campos da resposta

  • hourly

    Uma entrada por hora com envios, da mais antiga para a mais nova.

  • hourly[].hour

    O início da hora, RFC 3339 UTC.

  • hourly[].delivered / bounced / blocked / complaints / rate_limited

    Os contadores daquela hora (sem total nem taxas aqui).

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.