Buscar Reporte de Check-ins de Agregadores
Descripción
Retorna el reporte de check-ins realizados por agregadores, permitiendo filtrar por filial de origen, filial de check-in, período (fecha inicial y final) y lista de agregadores. El resultado admite paginación mediante los parámetros Take y Skip.
🔑 Parámetros de Consulta (Query Params)
| Parámetro | Tipo | Obligatorio | Descripción |
|---|
| DtStart | date-time | No | Fecha inicial para filtrar el período del check-in. |
| DtEnd | date-time | No | Fecha final para filtrar el período del check-in. |
| IdBranch | int32 | No | Filtrar por la filial de check-in. |
| IdBranchOrigin | int32 | No | Filtrar por la filial de origen donde el miembro o prospect está registrado. |
| CheckinBranchIds | array | No | Lista de IDs de filiales donde ocurrieron los check-ins. |
| Aggregators | array | No | Lista de agregadores. Ver opciones abajo. |
| Skip | int32 | No | Cantidad de registros que se deben omitir en la lista (paginación). |
| Take | int32 | No | Cantidad de registros que se deben retornar (paginación). Predeterminado: 25. Máximo: 50. |
🔷 Enum de aggregators
| Valor | Agregador |
|---|
| 1 | Wellhub (Gympass) |
| 2 | Totalpass |
| 7 | Gurupass |
| 9 | GoGood |
📤 Estructura de la Respuesta
La respuesta retorna el total de registros encontrados y una lista paginada con los check-ins realizados por agregadores, incluyendo información del miembro o prospect, filial de origen, filial donde ocurrió el check-in, fecha, estado, producto, token utilizado y agregador.
| Campo | Tipo | Descripción |
|---|
total | int32 | Cantidad total de registros encontrados según los filtros informados. |
list | array | Lista de check-ins de agregadores retornados en la consulta. |
🧩 Objeto list
| Campo | Tipo | Descripción |
|---|
idMember | int32 | ID del miembro vinculado al check-in, cuando corresponda. |
idProspect | int32 | ID del prospect vinculado al check-in, cuando corresponda. |
name | string | Nombre del miembro o prospect que realizó el check-in. |
originBranchId | int32 | ID de la filial de origen donde el miembro o prospect está registrado. |
originBranchName | string | Nombre de la filial de origen donde el miembro o prospect está registrado. |
checkinBranchId | int32 | ID de la filial donde se realizó el check-in. |
checkinDate | date-time | Fecha y hora del check-in en formato ISO 8601. |
checkinTime | string | Hora del check-in. |
status | string | Estado del check-in. |
product | string | Producto relacionado con el check-in del agregador. |
tokenUsed | string | Token utilizado para la validación o el registro del check-in. |
aggregator | string | Nombre del agregador responsable del check-in. |