Counters : Routes

Run Commands

Le point d'entrée unique pour les compteurs de votre compte. Envoyez de 1 à 20 commandes en une requête et obtenez un résultat par commande.

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

Même enveloppe que Logs et Contacts. Demandez les totaux, ce mois-ci et les 30 derniers jours en une seule requête.

i

Les erreurs sont signalées par commande. Une commande qui échoue n'arrête pas les autres, et le statut HTTP reste 200.

Paramètres du corps

  • commandsobject[]obligatoire

    1 à 20 commandes, exécutées dans l'ordre. Le corps entier peut faire jusqu'à 1 MB.

  • commands[].commandstringobligatoire

    get_totals, get_month, get_months, get_daily ou get_hourly.

  • commands[].argsobjectfacultatif

    Les arguments de la commande.

  • commands[].idstringfacultatif

    Votre propre identifiant pour le résultat. Par défaut, l'index ("0", "1"…).

Démarrage rapide

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

Réponse

{
  "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
      }
    }
  ]
}

Champs de la réponse

  • type

    Toujours SUCCESS lorsque la requête elle-même a été acceptée.

  • results[].command / id / type

    Quelle commande, votre id (ou l'index), et SUCCESS ou ERROR.

  • results[].data

    La sortie de la commande. Présente uniquement lorsque type vaut SUCCESS.

  • results[].code / message

    L'erreur. Présente uniquement lorsque type vaut ERROR.

Authentification

Utilisez l'API key que vous créez dans le dashboard, sous Developers → API Keys, avec le scope counters:read.

  • Authorization

    Envoyez Authorization: <api key> ou Authorization: Bearer <api key>.

  • counters:read

    Le seul scope dont cette route a besoin. Il est en lecture seule.

  • Tokens de mailbox

    Le token du webmail ne fonctionne pas ici. Il est rejeté avec WRONG_CREDENTIAL_TYPE.

Ce qui est compté

  • Chaque e-mail

    L'API, le relais SMTP et les campagnes, tous ensemble. Chaque e-mail compte une fois, lorsqu'il obtient son résultat final.

  • En temps réel

    Les compteurs bougent quelques secondes après chaque résultat de livraison. Il n'y a pas de traitement quotidien par lots.

  • Heures et mois en UTC

    get_hourly et get_month(s) utilisent l'UTC. get_daily construit les jours dans le fuseau horaire demandé.

Rate limits et cache

  • 15 requêtes / seconde

    Par IP + API key. Au-delà, vous recevez un HTTP 429 avec Retry-After.

  • Cache de lecture : 1,5 s

    La même commande avec les mêmes args à moins de 1,5 seconde d'intervalle renvoie le même résultat.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 400INVALID_JSON

    Le corps n'est pas {"commands":[...]} ou dépasse 1 MB.

  • 400INVALID_ARGS

    La requête ne contient aucune commande ou plus de 20.

  • 401MISSING_AUTH_HEADER

    Aucun header Authorization n'a été envoyé.

  • 401INVALID_API_KEY

    L'API key n'existe pas, a été révoquée ou a été désactivée dans le dashboard.

  • 401API_KEY_EXPIRED

    L'API key a dépassé la date d'expiration définie dans le dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Un token de mailbox a été envoyé. La Counters API nécessite une API key du dashboard.

  • 403IP_NOT_ALLOWED

    La requête provient d'une IP qui ne figure pas parmi les IP autorisées de la key.

  • 403ACCOUNT_BLOCKED

    Le compte est bloqué.

  • 403MISSING_SCOPE

    La key n'a pas `counters:read`, donc aucune commande ne peut s'exécuter.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.

  • 503AUTH_UNAVAILABLE

    L'authentification est temporairement indisponible. Réessayez.

  • CMDUNKNOWN_COMMAND

    Le nom de la commande n'existe pas.

  • CMDINTERNAL

    Erreur serveur. Le détail n'est écrit que dans le log du serveur.