Kontakte: Segmente
Segment ausführen
Holen Sie die Kontakte, die jetzt zu einem gespeicherten Segment passen. Gleiche Ausgabe und Paginierung wie Query Contacts.
https://g.sendcorex.com/v1/contactscommand: run_segmentErfordert den Scope contact:read auf Ihrem API Key.
Argumente
segment_idstringerforderlichDas auszuführende Segment.
z. B.
"engaged-vips"limitnumberoptionalSeitengröße, von 1 bis 1000. Standard: 50.
cursorstringoptionalDer
next_cursorder vorherigen Seite.selectstring[]optionalGibt nur diese Teile jedes Kontakts zurück, zum Beispiel
["status", "fields.plan", "stats.open_count"].emailkommt 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
contactsDie passenden Kontakte. Vollständig oder nur die mit
selectangefragten Teile.has_more / next_cursorPaginierung. Solange
has_moretrueist, senden Sienext_cursoralscursormit demselbenwhereundsort.plan.driverDer Index, den der Server zum Durchsuchen gewählt hat, zum Beispiel
tag:vipoderlist:customers.plan.examinedWie viele Indexeinträge gelesen wurden, um diese Seite zu füllen.
plan.keys_onlytrue, wenn die Seite allein aus dem Index beantwortet wurde, ohne die Kontakte zu laden.plan.msZeit 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.
- 401
INVALID_API_KEYDer API Key existiert nicht, wurde widerrufen oder im Dashboard deaktiviert.
- 429
RATE_LIMITEDMehr als 15 Requests/s oder 15 gleichzeitig für dieselbe IP + API Key. Warten Sie die Sekunden aus Retry-After ab.
- CMD
MISSING_SCOPEDem API Key fehlt der Scope, den dieser Befehl braucht. Die anderen Befehle im Request laufen trotzdem.
- CMD
INVALID_ARGSEin Pflichtargument fehlt oder ist ungültig: E-Mail, Feldwert, Enum-Option, where-Schlüssel, Listen-ID …
- CMD
NOT_FOUNDDer Kontakt, die Liste, das Feld oder das Segment existiert nicht.
- CMD
INVALID_CURSORDer Cursor ist fehlerhaft oder gehört zu einer anderen Abfrage oder einem anderen Konto.
- CMD
INTERNALServerfehler. Details werden nur ins Server-Log geschrieben.