Counters : Lecture

Obtenir par heure

Heure par heure (UTC), pour voir comment se déroule un envoi en ce moment. Seules les heures avec des envois sont listées.

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

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

i

Jusqu'à 7 jours par commande.

Arguments

  • fromstringobligatoire

    Début, RFC 3339. L'heure dans laquelle il tombe est incluse.

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

  • tostringobligatoire

    Fin, RFC 3339. L'heure dans laquelle elle tombe est incluse.

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

Démarrage rapide

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

Réponse

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

Champs de la réponse

  • hourly

    Une entrée par heure avec des envois, de la plus ancienne à la plus récente.

  • hourly[].hour

    Le début de l'heure, RFC 3339 UTC.

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

    Les compteurs de cette heure (pas de total ni de taux ici).

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.