Listar eventos

Supervisor
Supervisor

Nombre del servicio

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

Método de autenticación

Authorization: Bearer

Para más detalle sobre cómo generar clave API ver: Cómo enviar mails desde la API

Descripción

Devuelve una lista de todos los eventos por los cuales pasó cada envío.

🛈 Tener en cuenta que esta información se guarda por un período determinado que depende del plan que hayas contratado.

Parámetros

Nombre Tipo Descripción
domainID String ID de dominio. Requerido.
limit Integer Cantidad de registros por página. Por defecto: 10. Máximo: 100.
page Integer Número de página. Por defecto: 1.
sort String

Ordenar por. Valores posibles:

email  Email.

date  Fecha.

Por defecto: Fecha.

direction String

Tipo de ordenamiento. Valores posibles:

asc  Ascendente.  

desc  Descendente.

Por defecto: Ascendente.

filters String

Expresión para filtrar los registros. Ver detalle de la Generación de expresiones (*). Ejemplos:

{"type": "rejected_hard"} Filtra por evento 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 de evento.
email Destinatario.
mail_id ID del email (que registra el evento).
date Fecha del evento. Zona horaria UTC+00:00.
type

Evento. Valores posibles:

queued  Encolado

processed  Procesado

rejected_hard  Rebote duro

rejected_soft  Rebote blando

failed  Falla de envío

sent  Entregado

read  Abierto

click  Cliqueado

excluded  Excluido

complaint  Queja

Ejemplo de respuesta

{

    "page": 1,

    "limit": 100,

    "payload": [

        {

            "mail_id": "66197ea87486c516db0fc756",

            "type": "queued",

            "date": "2024-04-12T18:34:17+00:00",

            "email": "destinatario@email.com",

            "id": "66197ea93286c516db0fc28a"

        },

        {

            "mail_id": "66197ea87486c516db0fc756",

            "type": "processed",

            "date": "2024-04-12T18:34:18+00:00",

            "email": "destinatario@email.com",

            "id": "66197eaa6b266cd2bd037be3"

        },

        {

            "mail_id": "66197ea87486c516db0fc756",

            "type": "rejected_hard",

            "date": "2024-04-12T18:36:18+00:00",

            "email": "destinatario@email.com",

            "id": "66197eaa6b266cd2bd021be4"

        }

 

    ],

    "total": 3

}

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0

¿Tiene más preguntas? Enviar una solicitud

Comentarios

0 comentarios

El artículo está cerrado para comentarios.