EnvíaloSimple Transaccional — API: Listar eventos

Endpoint

GET https://api.envialosimple.email/api/v1/mailevents

Autenticación

Authorization: Bearer <clave API>

Descripción

Devuelve una lista de todos los eventos por los que pasó cada envío. La información se guarda por un período que depende del plan contratado.

Parámetros

Nombre	Tipo	Descripción
domainId	String	ID de dominio. Requerido.
limit	Integer	Registros por página. Por defecto: 10. Máximo: 100.
page	Integer	Número de página. Por defecto: 1.
sort	String	Ordenar por: email, date. Por defecto: date.
direction	String	Ordenamiento: asc (ascendente), desc (descendente). Por defecto: asc.
filters	String	Expresión para filtrar registros. Ejemplos: {"type": "rejected_hard"} filtra por rebote duro; {"date":{"$gt":{"$ts":1711971302}}} filtra por fecha mayor a; {"email":{"$regex":"prueba"}} filtra por email que contenga "prueba".

Respuesta

Campo	Descripción
id	ID del evento
email	Destinatario
mail_id	ID del email que registra el evento
date	Fecha del evento (UTC+00:00)
type	Evento: queued, processed, rejected_hard, rejected_soft, failed, sent, read, click, excluded, complaint

Errores

Error	Descripción
domain_required	El dominio es requerido
domain_not_allowed	No existe el dominio informado
invalid_direction	Tipo de ordenamiento incorrecto
invalid_page	Número de página incorrecto — debe ser entero positivo
invalid_limit	Cantidad de registros incorrecta — debe ser entero positivo
malformed_filter	Expresión de filtro incorrecta

Ejemplo de respuesta

{
  "page": 1,
  "limit": 100,
  "total": 3,
  "payload": [
    {
      "mail_id": "66197ea87486c516db0fc756",
      "type": "queued",
      "date": "2024-04-12T18:34:17+00:00",
      "email": "[email protected]",
      "id": "66197ea93286c516db0fc28a"
    },
    {
      "mail_id": "66197ea87486c516db0fc756",
      "type": "processed",
      "date": "2024-04-12T18:34:18+00:00",
      "email": "[email protected]",
      "id": "66197eaa6b266cd2bd037be3"
    },
    {
      "mail_id": "66197ea87486c516db0fc756",
      "type": "rejected_hard",
      "date": "2024-04-12T18:36:18+00:00",
      "email": "[email protected]",
      "id": "66197eaa6b266cd2bd021be4"
    }
  ]
}