Contactos: actividad

Listar eventos

El historial de un contacto, del más reciente al más antiguo: envíos, aperturas, clics, rebotes, quejas y bajas.

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

Necesita el scope contact:read en tu API key.

i

Los eventos los registran el envío y el tracking. La API solo los lee.

Argumentos

  • emailstringobligatorio

    El contacto.

    p. ej. "ana@acme.com"

  • typesstring[]opcional

    Solo estos tipos: sent, open, click, bounce, complaint, unsubscribe.

    p. ej. ["open", "click"]

  • limitnumberopcional

    Tamaño de página, de 1 a 1000. Por defecto, 50.

  • cursorstringopcional

    El next_cursor de la página anterior.

Inicio 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);

Respuesta

{
  "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 de la respuesta

  • events[].type

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

  • events[].at

    Cuándo ocurrió.

  • events[].campaign_id / list_id

    La campaña y la lista a las que pertenecía el email, cuando se conocen.

  • events[].url

    El enlace, en los eventos click.

  • events[].ip / user_agent

    De dónde vino la apertura o el clic.

  • events[].by_proxy

    true cuando la apertura vino de un proxy de privacidad de correo y no de la persona.

  • events[].reason / hard

    En bounce: el motivo, y si fue un rebote duro (hard bounce).

  • has_more / next_cursor

    Paginación. Envía next_cursor como cursor para obtener eventos más antiguos.

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.

  • 401INVALID_API_KEY

    La API key no existe, se revocó o se desactivó en el dashboard.

  • 429RATE_LIMITED

    Más de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.

  • CMDMISSING_SCOPE

    La API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.

  • CMDINVALID_ARGS

    Falta un argumento obligatorio o no es válido: email, valor de campo, opción de enum, clave del where, id de lista…

  • CMDINVALID_CURSOR

    El cursor tiene un formato incorrecto o pertenece a otra consulta o cuenta.

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.