Kontakte: Segmente

Segment ausführen

Holen Sie die Kontakte, die jetzt zu einem gespeicherten Segment passen. Gleiche Ausgabe und Paginierung wie Query Contacts.

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

Erfordert den Scope contact:read auf Ihrem API Key.

Argumente

  • segment_idstringerforderlich

    Das auszuführende Segment.

    z. B. "engaged-vips"

  • limitnumberoptional

    Seitengröße, von 1 bis 1000. Standard: 50.

  • cursorstringoptional

    Der next_cursor der vorherigen Seite.

  • selectstring[]optional

    Gibt nur diese Teile jedes Kontakts zurück, zum Beispiel ["status", "fields.plan", "stats.open_count"]. email kommt immer zurück. Ohne diesen Parameter erhalten Sie den vollständigen Kontakt.

Schnellstart

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "run_segment",
        args: {
          segment_id: "engaged-vips",
          select: [
            "first_name",
            "stats.open_rate"
          ],
          limit: 500
        }
      }
    ]
  },
  { 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": "run_segment",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "contacts": [
          {
            "email": "ana@acme.com",
            "first_name": "Ana",
            "stats": {
              "open_rate": 0.58
            }
          }
        ],
        "has_more": false,
        "next_cursor": null,
        "plan": {
          "driver": "tag:vip",
          "examined": 412,
          "keys_only": false,
          "ms": {
            "scan": 4,
            "fetch": 9,
            "filter": 1,
            "total": 14
          }
        }
      }
    }
  ]
}

Antwortfelder

  • contacts

    Die passenden Kontakte. Vollständig oder nur die mit select angefragten Teile.

  • has_more / next_cursor

    Paginierung. Solange has_more true ist, senden Sie next_cursor als cursor mit demselben where und sort.

  • plan.driver

    Der Index, den der Server zum Durchsuchen gewählt hat, zum Beispiel tag:vip oder list:customers.

  • plan.examined

    Wie viele Indexeinträge gelesen wurden, um diese Seite zu füllen.

  • plan.keys_only

    true, wenn die Seite allein aus dem Index beantwortet wurde, ohne die Kontakte zu laden.

  • plan.ms

    Zeit für Scannen, Laden, Filtern und insgesamt, in Millisekunden.

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 …

  • CMDNOT_FOUND

    Der Kontakt, die Liste, das Feld oder das Segment existiert nicht.

  • CMDINVALID_CURSOR

    Der Cursor ist fehlerhaft oder gehört zu einer anderen Abfrage oder einem anderen Konto.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.