Endpoint
Autenticación
Authorization: Bearer <clave API>
Descripción
Devuelve la analítica de eventos: aperturas, clics y quejas. 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: id (fecha), reads, clicks, complaints. Por defecto: id. |
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) |
reads | Aperturas |
clicks | Clics |
complaints | Quejas |
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-03", "reads": 50, "clicks": 45, "complaints": 0 },
{ "_id": "2023-12", "reads": 35, "clicks": 53, "complaints": 0 },
{ "_id": "2023-11", "reads": 90, "clicks": 66, "complaints": 2 },
{ "_id": "2023-10", "reads": 48, "clicks": 36, "complaints": 1 },
{ "_id": "2023-09", "reads": 73, "clicks": 65, "complaints": 3 },
{ "_id": "2023-08", "reads": 65, "clicks": 41, "complaints": 0 },
{ "_id": "2023-07", "reads": 72, "clicks": 70, "complaints": 0 },
{ "_id": "2023-06", "reads": 56, "clicks": 18, "complaints": 0 },
{ "_id": "2023-05", "reads": 32, "clicks": 20, "complaints": 0 }
],
"total": 9,
"limit": 50
}
Ejemplo de archivo exportado
Fecha;Abiertos;Cliqueados;Quejas
2024-03;50;45;0
2023-12;35;53;0
2023-11;90;66;2
2023-10;48;36;1
2023-09;73;65;3
2023-08;65;41;0
2023-07;72;70;0
2023-06;56;18;0
2023-05;32;20;0