Counters: Rutas

Run Commands

El punto de entrada único para los contadores de tu cuenta. Envía de 1 a 20 comandos en una solicitud y obtén un resultado por comando.

POSThttps://g.sendcorex.com/v1/counters
i

El mismo sobre que Logs y Contacts. Pide los totales, este mes y los últimos 30 días en una solicitud.

i

Los errores se informan por comando. Un comando que falla no detiene a los demás, y el estado HTTP sigue siendo 200.

Parámetros del cuerpo

  • commandsobject[]obligatorio

    De 1 a 20 comandos, ejecutados en orden. El cuerpo completo puede tener hasta 1 MB.

  • commands[].commandstringobligatorio

    get_totals, get_month, get_months, get_daily o get_hourly.

  • commands[].argsobjectopcional

    Los argumentos del comando.

  • commands[].idstringopcional

    Tu propio identificador para el resultado. Por defecto, el índice ("0", "1"…).

Inicio 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);
}

Respuesta

{
  "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 de la respuesta

  • type

    Siempre SUCCESS cuando la solicitud en sí fue aceptada.

  • results[].command / id / type

    Qué comando, tu id (o el índice), y SUCCESS o ERROR.

  • results[].data

    La salida del comando. Solo está presente cuando type es SUCCESS.

  • results[].code / message

    El error. Solo está presente cuando type es ERROR.

Autenticación

Usa la API key que creas en el dashboard, en Developers → API Keys, con el scope counters:read.

  • Authorization

    Envía Authorization: <api key> o Authorization: Bearer <api key>.

  • counters:read

    El único scope que necesita esta ruta. Es de solo lectura.

  • Tokens de mailbox

    El token del webmail no funciona aquí. Se rechaza con WRONG_CREDENTIAL_TYPE.

Qué se cuenta

  • Cada email

    API, SMTP relay y campañas, todo junto. Cada email cuenta una vez, cuando obtiene su resultado final.

  • En tiempo real

    Los contadores se mueven unos segundos después de cada resultado de entrega. No hay un proceso diario por lotes.

  • Horas y meses en UTC

    get_hourly y get_month(s) usan UTC. get_daily construye los días en la zona horaria que pidas.

Rate limits y caché

  • 15 solicitudes / segundo

    Por IP + API key. Por encima recibes HTTP 429 con Retry-After.

  • Caché de lectura: 1,5 s

    El mismo comando con los mismos args dentro de 1,5 segundos devuelve el mismo resultado.

Errores

Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.

  • 400INVALID_JSON

    El cuerpo no es {"commands":[...]} o pesa más de 1 MB.

  • 400INVALID_ARGS

    La solicitud no tiene comandos o tiene más de 20.

  • 401MISSING_AUTH_HEADER

    No se envió ningún header Authorization.

  • 401INVALID_API_KEY

    La API key no existe, fue revocada o se desactivó en el dashboard.

  • 401API_KEY_EXPIRED

    La API key superó la fecha de expiración definida en el dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Se envió un token de mailbox. La Counters API necesita una API key del dashboard.

  • 403IP_NOT_ALLOWED

    La solicitud vino de una IP que no está entre las IPs permitidas de la key.

  • 403ACCOUNT_BLOCKED

    La cuenta está bloqueada.

  • 403MISSING_SCOPE

    La key no tiene `counters:read`, así que no se puede ejecutar ningún comando.

  • 429RATE_LIMITED

    Más de 15 solicitudes/s o 15 simultáneas para la misma IP + API key. Espera el número de segundos indicado en Retry-After.

  • 503AUTH_UNAVAILABLE

    La autenticación no está disponible temporalmente. Inténtalo de nuevo.

  • CMDUNKNOWN_COMMAND

    El nombre del comando no existe.

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.