Endpoint
Autenticación
Authorization: Bearer <clave API>
Descripción
Devuelve la analítica de envíos: procesados, entregados y rechazados. Puede obtenerse un detalle paginado o generarse un archivo con los valores.
Parámetros
Nombre | Tipo | Descripción |
domainID | String | ID de dominio. Requerido. |
export | Boolean | true → genera un archivo con los valores. false → detalle paginado. |
lang | String | Idioma del archivo exportado: es (español), en (inglés). Solo para export=true. |
limit | Integer | Registros por página. Por defecto: 10. Máximo: 100. Solo para export=false. |
page | String | Número de página. Por defecto: 1. Solo para export=false. |
sort | String | Ordenar por: |
direction | String | Ordenamiento: asc (ascendente), desc (descendente). Por defecto: ascendente. |
dateFrom | Date | Fecha desde. Formato: AAAA-MM-DD. Ejemplo: 2024-02-01. |
dateTo | Date | Fecha hasta. Formato: AAAA-MM-DD. Ejemplo: 2024-02-29. |
groupBy | String | Agrupar por: year, month, week, day. Por defecto: día. |
Respuesta
Campo | Descripción |
_id | Fecha (día, semana, mes o año según groupBy) |
processed | Emails procesados |
delivered | Emails entregados |
rejected | Emails rechazados |
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 |
invalid_group_by | Valor de agrupamiento no válido |
Ejemplo de respuesta
{
"page": 1,
"payload": [
{ "_id": "2024-02-29", "processed": 500, "delivered": 490, "rejected": 10 },
{ "_id": "2024-02-16", "processed": 382, "delivered": 380, "rejected": 2 },
{ "_id": "2024-02-15", "processed": 430, "delivered": 430, "rejected": 0 }
],
"total": 3,
"limit": 10
}Ejemplo de archivo exportado
Fecha;Procesados;Entregados;Rechazados
2024-02-29;500;490;10
2024-02-16;382;380;2
2024-02-15;430;430;0