Endpoint
Autenticación
Authorization: Bearer <clave API>
Descripción
Devuelve un archivo CSV con todos los emails enviados.
Parámetros
Nombre | Tipo | Descripción |
domainID | String | ID de dominio. Requerido. |
sort | String | Ordenar por: created_date, from, to, subject. Por defecto: created_date. |
direction | String | Ordenamiento: asc (ascendente), desc (descendente). Por defecto: desc. |
lang | String | Idioma del archivo: es (español), en (inglés). |
filters | String | Expresión para filtrar registros. Ejemplos: {"status": "excluded"} filtra por estado excluido; {"created_date":{"$gt":{"$ts":1711971302}}} filtra por fecha de creación mayor a; {"to":{"$regex":"prueba"}} filtra por destinatario que contenga "prueba". |
Respuesta
Campo | Descripción |
ID | ID del email |
Fecha | Fecha de creación según la zona horaria de la cuenta |
Remitente | Remitente del email |
Destinatario | Destinatario del email |
Asunto | Asunto del email |
Estado | Estado: Procesado, Entregado, Rechazado, Falla de envío, Excluido |
Formato | Formato: Texto plano, HTML |
Canal | Canal de envío: API, SMTP, Vista previa |
Errores
Error | Descripción |
domain_required | El dominio es requerido |
domain_not_allowed | No existe el dominio informado |
invalid_direction | Tipo de ordenamiento incorrecto |
malformed_filter | Expresión de filtro incorrecta |
Ejemplo de respuesta
ID;Fecha;Remitente;Destinatario;Formato;Canal;Asunto;Estado
661d0f6b6a351e9936375e02;15/04/2024 08:28:43;"Empresa" <[email protected]>;[email protected];Texto;API;Confirmación de pedido;Entregado
661d0e4cf0f90d40880a5589;15/04/2024 08:23:56;"Empresa" <[email protected]>;[email protected];HTML;API;Recibimos la documentación!;Entregado
