Saltar al contenido principal

Reporte de Cantidad de Servicios

Conteo de tareas agregado por dimensiones de agrupación configurables.

GET/apidev/v1/reports/gt/quantity-service
PermisoAPICLI_RPTGT_QS
Límite de solicitudes10 req/min (ventana deslizante)
Caché300s (5 min)
Rango máximo31 días

Resumen​

Devuelve conteos de tareas agregados por una única dimensión de agrupación: por dispositivo, conductor, día, ciudad, causa y más. Úsalo para medir la distribución de la carga de trabajo y detectar dónde se concentra el volumen de servicio.

  • Agrupación — group_by elige la dimensión que representa cada fila (ver los valores más abajo)
  • Base de fecha — date_field controla si el rango filtra por fecha de creación, programada o de finalización
  • Filtrado — acota los resultados por dispositivos, conductores, tipos de servicio, proveedores y otros filtros de catálogo

Solicitud​

Encabezados de la solicitud​

Every request to a protected endpoint requires these headers:

HeaderRequiredDescription
AuthorizationYesBearer token obtained from the Login endpoint. Format: Bearer <token>
X-API-KeyYesCompany integration key provided during onboarding. Format: gtk_xxx...
tenantYesYour assigned tenant domain (default: geotareas.com) — always send your assigned tenant
Content-TypeConditionalapplication/json — required for POST and PUT requests

Parámetros de consulta​

ParámetroTipoRequeridoPredeterminadoDescripción
startdatestringSí—Fecha-hora de inicio en ISO 8601
enddatestringSí—Fecha-hora de fin en ISO 8601. Rango máximo 31 días
devicesstringNoTodos los visiblesIDs de dispositivos separados por coma. Máximo 500
driversstringNoTodosIDs de conductores separados por coma. Máximo 500
service_typesstringNoTodosIDs de tipos de servicio separados por coma. Máximo 100
causesstringNoTodasIDs de causas separados por coma. Máximo 100
subcausesstringNoTodasIDs de subcausas separados por coma. Máximo 100
statusesstringNoTodosCódigos de estado separados por coma. Máximo 100
device_groupsstringNoTodosIds de tipo de dispositivo separados por comas (el catálogo device_group que expone Flota / Dispositivos). Acota las tareas a los dispositivos de esos tipos; se combina con devices como intersección. Máximo 100
originsstringNoTodosIDs de orígenes separados por coma. Máximo 100
providersstringNoTodosIDs de proveedores separados por coma. Máximo 100
route_idsstringNoTodasIDs de rutas separados por coma. Máximo 100
operatorsstringNoTodosIDs de operadores separados por coma. Máximo 100
client_idstringNo—Filtrar por un cliente específico
account_idstringNo—Filtrar por una cuenta específica
shift_idstringNo—Filtrar por un turno específico
date_fieldenumNo—Campo de fecha sobre el cual filtrar: created, scheduled, finished
group_byenumNo—Dimensión de agrupación (ver abajo)
limitintegerNo25Registros por página (1–100)
offsetintegerNo0Registros a omitir
Cómo se combina device_groups con devices

device_groups se expande a todos los dispositivos de esos tipos, y si además mandás devices, se quedan solo los dispositivos que están en las dos listas. Si esa intersección queda vacía, el reporte no devuelve filas.

Valores de group_by​

date · month · hour · weekday · department · city · zone · provider · device · device_group · driver · shift · cause · subcause · end_code · origin · telephonist · operator


Ejemplos de código​

curl -s -H "Authorization: Bearer $TOKEN" \
-H "X-API-Key: $APIKEY" \
-H "tenant: $TENANT" \
"https://$TENANT/apidev/v1/reports/gt/quantity-service?startdate=2026-03-01T00:00:00&enddate=2026-03-31T23:59:59&group_by=device&limit=25"

Campos de la respuesta​

CampoTipoDescripción
group_labelstringNombre visible del grupo
group_idstring | nullIdentificador del elemento del grupo
total_tasksnumberCantidad total de tareas
dist_totalnumberDistancia total de todas las tareas (km)
dist_avgnumberDistancia promedio por tarea (km)

Respuesta de ejemplo​

{
"success": true,
"data": [
{
"group_label": "Truck A-101",
"group_id": "104820579301",
"total_tasks": 47,
"dist_total": 892.3,
"dist_avg": 18.98
},
{
"group_label": "Truck B-205",
"group_id": "104820579402",
"total_tasks": 32,
"dist_total": 614.7,
"dist_avg": 19.21
}
],
"meta": {
"total": 2,
"limit": 25,
"offset": 0
}
}

Errores​

CódigoHTTPDescripción
VALIDATION_ERROR400Parámetros inválidos: fechas faltantes, rango > 31 días, group_by inválido
UNAUTHORIZED401tenant / Authorization / X-API-Key faltante, inválido o expirado
FORBIDDEN403El usuario carece del permiso requerido
RATE_LIMITED429Se superaron 10 req/min
INTERNAL_ERROR500Error inesperado del servidor