Endpoint
Autenticación
Authorization: Bearer <clave API>
Descripción
Devuelve la analítica de rebotes: duros, blandos y total. 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), hard, soft, total. 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) |
hard | Rebotes duros |
soft | Rebotes blandos |
total | Total de rebotes (duros + blandos) |
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", "total": 4, "hard": 1, "soft": 3 },
{ "_id": "2024-01", "total": 5, "hard": 3, "soft": 2 },
{ "_id": "2024-04", "total": 1, "hard": 0, "soft": 1 }
],
"total": 3,
"limit": 20
}Ejemplo de archivo exportado
Fecha;Rebote duro;Rebote blando;Total
2024-03;1;3;4
2024-01;3;2;5
2024-04;0;1;1