Kontakte: Suche

Kontakte zählen

Zählen Sie die Kontakte, die zu einem where passen, ohne sie abzurufen. Nützlich, um vor einem Versand „1.834 Personen erhalten dies“ anzuzeigen.

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

Erfordert den Scope contact:read auf Ihrem API Key.

Argumente

  • whereobjectoptional

    Dasselbe where wie bei Query Contacts. Lassen Sie es weg, um alle Kontakte zu zählen.

  • maxnumberoptional

    Hört bei dieser Zahl auf zu zählen, von 1 bis 1.000.000. Standard: 100.000.

Schnellstart

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "count_contacts",
        args: {
          where: {
            list: "customers",
            sendable: true
          }
        }
      }
    ]
  },
  { 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": "count_contacts",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "count": 1790,
        "exact": true
      }
    }
  ]
}

Antwortfelder

  • count

    Wie viele Kontakte gepasst haben.

  • exact

    false, wenn das Zählen vorzeitig gestoppt hat, bei max oder am Zeitlimit des Requests. Die tatsächliche Zahl ist dann mindestens count.

Summen ohne Zählen

Für Summen pro Status, Liste oder Tag ist Get Stats günstiger: Es liest Zähler, die bei jeder Änderung aktualisiert werden, statt die Kontakte zu durchlaufen.

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.

  • CMDINVALID_ARGS

    Ein Pflichtargument fehlt oder ist ungültig: E-Mail, Feldwert, Enum-Option, where-Schlüssel, Listen-ID …

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.