Kontakte: Aktivität

Statistiken abrufen

Summen für das ganze Konto in einem Aufruf: Kontakte, Kontakte pro Status, Mitglieder pro Liste und Kontakte pro Tag.

POSThttps://g.sendcorex.com/v1/contactscommand: get_stats
i

Erfordert den Scope contact:read auf Ihrem API Key.

i

Diese Zähler werden bei jeder Änderung aktualisiert, der Aufruf ist also günstig, wenn ein Dashboard geöffnet wird.

Argumente

Dieser Endpoint hat keine Argumente.

Schnellstart

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "get_stats"
      }
    ]
  },
  { 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);

Antwort

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "get_stats",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "total": 2040,
        "status": {
          "subscribed": 1951,
          "unsubscribed": 61,
          "bounced": 22,
          "complained": 3,
          "blocked": 3
        },
        "lists": {
          "customers": {
            "total": 1834,
            "ok": 1790,
            "opened": 912,
            "clicked": 233
          },
          "newsletter": {
            "total": 640,
            "ok": 602,
            "opened": 288,
            "clicked": 41
          }
        },
        "tags": {
          "customer": 1834,
          "vip": 120,
          "black-friday": 512
        }
      }
    }
  ]
}

Antwortfelder

  • total

    Kontakte im Konto.

  • status

    Kontakte pro globalem Status.

  • lists.<id>

    total Mitglieder, ok anschreibbare Mitglieder sowie Mitglieder, die opened oder clicked haben.

  • tags

    Kontakte pro Tag.

Fehler

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

  • 401INVALID_API_KEY

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

  • 429RATE_LIMITED

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

  • CMDMISSING_SCOPE

    Dem API Key fehlt der Scope, den dieser Befehl braucht. Die anderen Befehle im Request laufen trotzdem.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.