Contatos: atividade
Listar eventos
O histórico de um contato, do mais recente ao mais antigo: envios, aberturas, cliques, bounces, reclamações e descadastros.
https://g.sendcorex.com/v1/contactscommand: list_eventsPrecisa do scope contact:read na sua API key.
Os eventos são registrados pelo envio e pelo tracking. A API só os lê.
Argumentos
emailstringobrigatórioO contato.
ex.:
"ana@acme.com"typesstring[]opcionalSomente estes tipos:
sent,open,click,bounce,complaint,unsubscribe.ex.:
["open", "click"]limitnumberopcionalTamanho da página, de 1 a 1000. Padrão: 50.
cursorstringopcionalO
next_cursorda página anterior.
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "list_events",
args: {
email: "ana@acme.com",
types: [
"open",
"click"
],
limit: 50
}
}
]
},
{ 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": "list_events",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"events": [
{
"event_id": "ev_7c1d02",
"type": "click",
"at": "2026-10-14T21:04:10.000Z",
"campaign_id": "cmp_october",
"list_id": "customers",
"url": "https://acme.com/offer",
"ip": "203.0.113.24",
"user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_0 like Mac OS X)",
"reason": null,
"by_proxy": false,
"hard": null,
"meta": null
},
{
"event_id": "ev_7c1cf9",
"type": "open",
"at": "2026-10-14T21:03:55.000Z",
"campaign_id": "cmp_october",
"list_id": "customers",
"url": null,
"ip": "203.0.113.24",
"user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_0 like Mac OS X)",
"reason": null,
"by_proxy": false,
"hard": null,
"meta": null
}
],
"has_more": true,
"next_cursor": "eyJ0IjoxNzYwNDc1ODM1fQ"
}
}
]
}Campos da resposta
events[].typesent,open,click,bounce,complaintouunsubscribe.events[].atQuando aconteceu.
events[].campaign_id / list_idA campanha e a lista a que o email pertencia, quando conhecidas.
events[].urlO link, em eventos
click.events[].ip / user_agentDe onde veio a abertura ou o clique.
events[].by_proxytruequando a abertura veio de um proxy de privacidade de email e não da pessoa.events[].reason / hardEm
bounce: o motivo e se foi um hard bounce.has_more / next_cursorPaginação. Envie
next_cursorcomocursorpara obter eventos mais antigos.
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
INVALID_CURSORO cursor está malformado ou pertence a outra consulta ou conta.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.