Counters : Lecture

Obtenir un mois

Un mois calendaire (UTC). Sans `month`, le mois en cours.

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

Nécessite le scope counters:read sur votre API key.

Arguments

  • monthstringfacultatif

    Le mois, YYYY-MM. Par défaut : le mois en cours en UTC.

    ex. : "2026-10"

Démarrage rapide

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

Réponse

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

Champs de la réponse

  • month

    Le mois, YYYY-MM.

  • delivered

    Les e-mails acceptés par le serveur destinataire.

  • bounced

    Les e-mails qui ne sont pas passés : rejetés par le serveur destinataire, expirés dans la file ou arrêtés avant l'envoi. La raison de chacun se trouve dans Bounces & Complaints.

  • blocked

    Les e-mails refusés par le serveur destinataire comme spam, par politique ou pour réputation au moment de la livraison. L'adresse est bonne : le problème venait de l'envoi (qualité de la liste, volume, authentification, contenu).

  • complaints

    Les destinataires qui ont signalé votre e-mail comme spam après l'avoir reçu : feedback loops (Outlook, Yahoo…) et signalements d'abus. Ne font pas partie de total, puisque ces e-mails ont déjà été comptés comme livrés.

  • rate_limited

    Les e-mails que le serveur destinataire n'a cessé de différer jusqu'à épuisement des tentatives.

  • total

    delivered + bounced + blocked + rate_limited : chaque e-mail qui a obtenu un résultat.

  • delivered_rate / bounce_rate / blocked_rate / complaint_rate / rate_limited_rate

    Chaque compteur en pourcentage de total, avec 2 décimales. 0 lorsque total vaut 0.

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.

  • 401INVALID_API_KEY

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

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

  • CMDMISSING_SCOPE

    L'API key n'a pas `counters:read`.

  • CMDINVALID_ARGS

    Un argument est invalide : un mois qui n'est pas au format YYYY-MM, un jour qui n'est pas au format YYYY-MM-DD, un fuseau horaire inconnu, from postérieur à to, une plage trop longue…

  • CMDINTERNAL

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