Counters: Lectura

Obtener mes

Un mes del calendario (UTC). Sin `month`, el actual.

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

Requiere el scope counters:read en tu API key.

Argumentos

  • monthstringopcional

    El mes, YYYY-MM. Por defecto, el mes actual en UTC.

    p. ej. "2026-10"

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

Respuesta

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

  • month

    El mes, YYYY-MM.

  • delivered

    Emails que el servidor de destino aceptó.

  • bounced

    Emails que no pasaron: rechazados por el servidor de destino, expirados en la cola o detenidos antes del envío. El motivo de cada uno está en Bounces & Complaints.

  • blocked

    Emails que el servidor de destino rechazó como spam, por política o por reputación en el momento de la entrega. La dirección está bien: el problema fue el envío (calidad de la lista, volumen, autenticación, contenido).

  • complaints

    Destinatarios que reportaron tu email como spam después de recibirlo: feedback loops (Outlook, Yahoo…) y reportes de abuso. No forman parte de total, ya que esos emails ya se contaron como entregados.

  • rate_limited

    Emails que el servidor de destino siguió aplazando hasta que se agotaron los reintentos.

  • total

    delivered + bounced + blocked + rate_limited: cada email que obtuvo un resultado.

  • delivered_rate / bounce_rate / blocked_rate / complaint_rate / rate_limited_rate

    Cada contador como porcentaje de total, con 2 decimales. 0 cuando total es 0.

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.

  • 401INVALID_API_KEY

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

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

  • CMDMISSING_SCOPE

    La API key no tiene `counters:read`.

  • CMDINVALID_ARGS

    Un argumento no es válido: un mes que no es YYYY-MM, un día que no es YYYY-MM-DD, una zona horaria desconocida, from posterior a to, un rango demasiado largo…

  • CMDINTERNAL

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