Contacts : segments
Exécuter un segment
Obtenez maintenant les contacts qui correspondent à un segment enregistré. Même sortie et même pagination que Query Contacts.
https://g.sendcorex.com/v1/contactscommand: run_segmentNécessite le scope contact:read sur votre API key.
Arguments
segment_idstringobligatoireLe segment à exécuter.
ex. :
"engaged-vips"limitnumberfacultatifTaille de page, de 1 à 1000. 50 par défaut.
cursorstringfacultatifLe
next_cursorde la page précédente.selectstring[]facultatifNe renvoie que ces parties de chaque contact, par exemple
["status", "fields.plan", "stats.open_count"].emailrevient toujours. Sans lui, vous obtenez le contact complet.
Démarrage rapide
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);Réponse
{
"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
}
}
}
}
]
}Champs de la réponse
contactsLes contacts trouvés. Complets, ou uniquement les parties demandées avec
select.has_more / next_cursorPagination. Tant que
has_morevauttrue, envoyeznext_cursorcommecursoravec les mêmeswhereetsort.plan.driverL'index que le serveur a choisi de parcourir, par exemple
tag:vipoulist:customers.plan.examinedCombien d'entrées d'index ont été lues pour remplir cette page.
plan.keys_onlytruequand la page a été servie uniquement depuis l'index, sans charger les contacts.plan.msTemps passé à parcourir, charger, filtrer et au total, en millisecondes.
Erreurs
Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.
- 401
INVALID_API_KEYL'API key n'existe pas, a été révoquée ou désactivée dans le dashboard.
- 429
RATE_LIMITEDPlus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.
- CMD
MISSING_SCOPEL'API key n'a pas le scope requis par cette commande. Les autres commandes de la requête s'exécutent quand même.
- CMD
INVALID_ARGSUn argument obligatoire est manquant ou invalide : email, valeur de champ, option d'enum, clé de where, id de liste…
- CMD
NOT_FOUNDLe contact, la liste, le champ ou le segment n'existe pas.
- CMD
INVALID_CURSORLe cursor est mal formé ou appartient à une autre requête ou à un autre compte.
- CMD
INTERNALErreur serveur. Le détail n'est écrit que dans le log du serveur.