Counters: Routen

Run Commands

Der einzige Einstiegspunkt für die Zähler Ihres Kontos. Senden Sie 1 bis 20 Befehle in einem Request und erhalten Sie ein Ergebnis pro Befehl.

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

Derselbe Umschlag wie bei Logs und Contacts. Fragen Sie Summen, diesen Monat und die letzten 30 Tage in einem Request ab.

i

Fehler werden pro Befehl gemeldet. Ein fehlgeschlagener Befehl stoppt die anderen nicht, und der HTTP-Status bleibt 200.

Body-Parameter

  • commandsobject[]erforderlich

    1 bis 20 Befehle, der Reihe nach ausgeführt. Der gesamte Body darf bis zu 1 MB groß sein.

  • commands[].commandstringerforderlich

    get_totals, get_month, get_months, get_daily oder get_hourly.

  • commands[].argsobjectoptional

    Die Argumente des Befehls.

  • commands[].idstringoptional

    Ihr eigener Bezeichner für das Ergebnis. Standard ist der Index ("0", "1"…).

Schnellstart

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

Antwort

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

Antwortfelder

  • type

    Immer SUCCESS, wenn der Request selbst angenommen wurde.

  • results[].command / id / type

    Welcher Befehl, Ihre ID (oder der Index) und SUCCESS oder ERROR.

  • results[].data

    Die Ausgabe des Befehls. Nur vorhanden, wenn type SUCCESS ist.

  • results[].code / message

    Der Fehler. Nur vorhanden, wenn type ERROR ist.

Authentifizierung

Verwenden Sie den API key, den Sie im Dashboard unter Developers → API Keys erstellen, mit dem Scope counters:read.

  • Authorization

    Senden Sie Authorization: <api key> oder Authorization: Bearer <api key>.

  • counters:read

    Der einzige Scope, den diese Route braucht. Er ist nur lesend.

  • Mailbox-Tokens

    Der Webmail-Token funktioniert hier nicht. Er wird mit WRONG_CREDENTIAL_TYPE abgelehnt.

Was gezählt wird

  • Jede E-Mail

    API, SMTP-Relay und Kampagnen, alles zusammen. Jede E-Mail zählt einmal, sobald sie ihr endgültiges Ergebnis hat.

  • Live

    Die Zähler bewegen sich wenige Sekunden nach jedem Zustellergebnis. Es gibt keinen täglichen Batch.

  • Stunden und Monate in UTC

    get_hourly und get_month(s) verwenden UTC. get_daily bildet die Tage in der angefragten Zeitzone.

Rate limits und Cache

  • 15 Requests / Sekunde

    Pro IP + API key. Darüber erhalten Sie HTTP 429 mit Retry-After.

  • Lese-Cache: 1,5 s

    Derselbe Befehl mit denselben Args innerhalb von 1,5 Sekunden liefert dasselbe Ergebnis.

Fehler

Fehler auf HTTP-Ebene liefern type, code und message. Mit CMD markierte Fehler kommen im Befehlsergebnis zurück, mit HTTP 200.

  • 400INVALID_JSON

    Der Body ist nicht {"commands":[...]} oder größer als 1 MB.

  • 400INVALID_ARGS

    Der Request enthält keine Befehle oder mehr als 20.

  • 401MISSING_AUTH_HEADER

    Es wurde kein Authorization-Header gesendet.

  • 401INVALID_API_KEY

    Der API key existiert nicht, wurde widerrufen oder im Dashboard deaktiviert.

  • 401API_KEY_EXPIRED

    Der API key hat das im Dashboard festgelegte Ablaufdatum überschritten.

  • 401WRONG_CREDENTIAL_TYPE

    Es wurde ein Mailbox-Token gesendet. Die Counters API braucht einen API key aus dem Dashboard.

  • 403IP_NOT_ALLOWED

    Der Request kam von einer IP, die nicht zu den erlaubten IPs des Keys gehört.

  • 403ACCOUNT_BLOCKED

    Das Konto ist gesperrt.

  • 403MISSING_SCOPE

    Der Key hat `counters:read` nicht, daher kann kein Befehl ausgeführt werden.

  • 429RATE_LIMITED

    Mehr als 15 Requests/s oder 15 gleichzeitig für dieselbe IP + API key. Warten Sie die Anzahl Sekunden aus Retry-After ab.

  • 503AUTH_UNAVAILABLE

    Die Authentifizierung ist vorübergehend nicht verfügbar. Versuchen Sie es erneut.

  • CMDUNKNOWN_COMMAND

    Der Befehlsname existiert nicht.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.