Contactos: segmentos
Ejecutar segmento
Obtén ahora los contactos que cumplen un segmento guardado. Misma salida y paginación que Query Contacts.
https://g.sendcorex.com/v1/contactscommand: run_segmentNecesita el scope contact:read en tu API key.
Argumentos
segment_idstringobligatorioEl segmento que se ejecuta.
p. ej.
"engaged-vips"limitnumberopcionalTamaño de página, de 1 a 1000. Por defecto, 50.
cursorstringopcionalEl
next_cursorde la página anterior.selectstring[]opcionalDevuelve solo estas partes de cada contacto, por ejemplo
["status", "fields.plan", "stats.open_count"].emailsiempre vuelve. Sin él, recibes el contacto completo.
Inicio rápido
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);Respuesta
{
"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
}
}
}
}
]
}Campos de la respuesta
contactsLos contactos encontrados. Contactos completos, o solo las partes que pediste con
select.has_more / next_cursorPaginación. Mientras
has_moreseatrue, envíanext_cursorcomocursorcon el mismowhereysort.plan.driverEl índice que el servidor eligió recorrer, por ejemplo
tag:vipolist:customers.plan.examinedCuántas entradas del índice se leyeron para llenar esta página.
plan.keys_onlytruecuando la página se respondió solo desde el índice, sin cargar los contactos.plan.msTiempo dedicado a recorrer, cargar, filtrar y en total, en milisegundos.
Errores
Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.
- 401
INVALID_API_KEYLa API key no existe, se revocó o se desactivó en el dashboard.
- 429
RATE_LIMITEDMás de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.
- CMD
MISSING_SCOPELa API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.
- CMD
INVALID_ARGSFalta un argumento obligatorio o no es válido: email, valor de campo, opción de enum, clave del where, id de lista…
- CMD
NOT_FOUNDEl contacto, la lista, el campo o el segmento no existe.
- CMD
INVALID_CURSOREl cursor tiene un formato incorrecto o pertenece a otra consulta o cuenta.
- CMD
INTERNALError del servidor. El detalle solo se escribe en el log del servidor.