Contatos: atividade

Listar eventos

O histórico de um contato, do mais recente ao mais antigo: envios, aberturas, cliques, bounces, reclamações e descadastros.

POSThttps://g.sendcorex.com/v1/contactscommand: list_events
i

Precisa do scope contact:read na sua API key.

i

Os eventos são registrados pelo envio e pelo tracking. A API só os lê.

Argumentos

  • emailstringobrigatório

    O contato.

    ex.: "ana@acme.com"

  • typesstring[]opcional

    Somente estes tipos: sent, open, click, bounce, complaint, unsubscribe.

    ex.: ["open", "click"]

  • limitnumberopcional

    Tamanho da página, de 1 a 1000. Padrão: 50.

  • cursorstringopcional

    O next_cursor da 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[].type

    sent, open, click, bounce, complaint ou unsubscribe.

  • events[].at

    Quando aconteceu.

  • events[].campaign_id / list_id

    A campanha e a lista a que o email pertencia, quando conhecidas.

  • events[].url

    O link, em eventos click.

  • events[].ip / user_agent

    De onde veio a abertura ou o clique.

  • events[].by_proxy

    true quando a abertura veio de um proxy de privacidade de email e não da pessoa.

  • events[].reason / hard

    Em bounce: o motivo e se foi um hard bounce.

  • has_more / next_cursor

    Paginação. Envie next_cursor como cursor para 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.

  • 401INVALID_API_KEY

    A API key não existe, foi revogada ou foi desativada no dashboard.

  • 429RATE_LIMITED

    Mais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.

  • CMDMISSING_SCOPE

    A API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.

  • CMDINVALID_ARGS

    Um argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…

  • CMDINVALID_CURSOR

    O cursor está malformado ou pertence a outra consulta ou conta.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.