Contatos: segmentos
Executar segmento
Obtenha agora os contatos que correspondem a um segmento salvo. Mesma saída e paginação de Query Contacts.
https://g.sendcorex.com/v1/contactscommand: run_segmentPrecisa do scope contact:read na sua API key.
Argumentos
segment_idstringobrigatórioO segmento a executar.
ex.:
"engaged-vips"limitnumberopcionalTamanho da página, de 1 a 1000. Padrão: 50.
cursorstringopcionalO
next_cursorda página anterior.selectstring[]opcionalRetorna só estas partes de cada contato, por exemplo
["status", "fields.plan", "stats.open_count"].emailsempre volta. Sem isso, você recebe o contato inteiro.
Início 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);Resposta
{
"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 da resposta
contactsOs contatos encontrados. Contatos inteiros, ou só as partes que você pediu com
select.has_more / next_cursorPaginação. Enquanto
has_morefortrue, envienext_cursorcomocursorcom o mesmowhereesort.plan.driverO índice que o servidor escolheu varrer, por exemplo
tag:vipoulist:customers.plan.examinedQuantas entradas do índice foram lidas para preencher esta página.
plan.keys_onlytruequando a página foi respondida só pelo índice, sem carregar os contatos.plan.msTempo gasto varrendo, buscando, filtrando e no total, em milissegundos.
Erros
Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 429
RATE_LIMITEDMais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.
- CMD
MISSING_SCOPEA API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.
- CMD
INVALID_ARGSUm argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…
- CMD
NOT_FOUNDO contato, a lista, o campo ou o segmento não existe.
- CMD
INVALID_CURSORO cursor está malformado ou pertence a outra consulta ou conta.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.