Saltar al contenido principal

Reporte de Eficiencia de Flota

KPIs operativos por grupo de vehículos — cantidad de tareas finalizadas y totales de distancia, con espacios reservados para métricas de tiempo inactivo y CO2 derivadas del GPS.

GET/apidev/v1/reports/gt/fleet-efficiency
PermisoAPICLI_RPTGT_EFICIENCIAFLOTA
Límite de tasa10 req/min
Caché300s
Rango máximo92 días

Resumen​

Este reporte devuelve métricas operativas de flota para tareas finalizadas, agrupadas por grupo — por prestador, dispositivo, conductor, tipo de servicio, causa, geografía, fecha y más. Cada fila reporta la cantidad de tareas más los totales de distancia (suma, promedio, mínimo, máximo) durante el período seleccionado. Elegí cómo se agrupan las filas con group_by (por defecto es prestador).

Los campos idle_ratio_pct y co2_estimado_kg se devuelven como espacios reservados fijados en 0. Estas métricas se derivan del rastreo GPS en crudo y se calculan en la capa de la aplicación en lugar de en este endpoint agregado, por lo que están presentes en la forma de la respuesta por compatibilidad futura pero no se completan aquí.


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ámetroTipoRequeridoPor defectoDescripción
startdatestringSí—Fecha-hora de inicio en ISO 8601 (ej. 2026-03-01T00:00:00).
enddatestringSí—Fecha-hora de fin en ISO 8601. Rango máximo de 92 días desde startdate.
group_bystringNoproviderCómo se agrupan las filas. Uno de: provider, device, driver, cause, subcause, service_type, product, origin, shift, end_code, comm_media, route, country, department, city, zone, client, telephonist, operator, resource_type, date, month, weekday, hour.
devicesstringNo—IDs de dispositivos separados por coma. Máx 500.
driversstringNo—IDs de conductores separados por coma. Máx 500.
providersstringNo—IDs de prestadores separados por coma. Máx 100.
service_typesstringNo—IDs de tipos de servicio separados por coma. Máx 100.
causesstringNo—IDs de causas separados por coma. Máx 100.
subcausesstringNo—IDs de subcausas separados por coma. Máx 100.
statusesstringNo—Códigos de estado de tarea separados por coma. Máx 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
originsstringNo—IDs de orígenes separados por coma. Máx 100.
route_idsstringNo—IDs de rutas separados por coma. Máx 100.
operatorsstringNo—IDs de operadores separados por coma. Máx 100.
client_idstringNo—ID de un solo cliente.
account_idstringNo—ID de una sola cuenta.
shift_idstringNo—ID de un solo turno.
limitintegerNo25Cantidad de registros por página (1–100).
offsetintegerNo0Cantidad de registros a omitir para la paginación.
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.


Ejemplos de código​

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

Respuesta​

Campos de la respuesta​

CampoTipoDescripción
group_labelstringNombre visible del grupo (ej. dispositivo, conductor, prestador).
group_idstring | nullID interno del grupo, o null cuando no se puede resolver.
totalnumberTotal de tareas finalizadas en el grupo.
dist_totalnumberDistancia total de las tareas del grupo.
dist_promnumberDistancia promedio por tarea.
dist_maxnumberDistancia máxima de una sola tarea.
dist_minnumberDistancia mínima distinta de cero de una sola tarea.
idle_ratio_pctnumberEspacio reservado para el ratio de tiempo inactivo derivado del GPS. Siempre 0 desde este endpoint.
co2_estimado_kgnumberEspacio reservado para el CO2 estimado derivado del GPS. Siempre 0 desde este endpoint.

Ejemplo de respuesta​

{
"success": true,
"data": [
{
"group_label": "Truck A-101",
"group_id": "55012",
"total": 138,
"dist_total": 4210,
"dist_prom": 31,
"dist_max": 92,
"dist_min": 4,
"idle_ratio_pct": 0,
"co2_estimado_kg": 0
}
],
"meta": {
"total": 1,
"limit": 25,
"offset": 0
}
}

Errores​

CódigoHTTPDescripción
VALIDATION_ERROR400Parámetros inválidos: fechas faltantes, rango > 92 días, valores de enum inválidos.
UNAUTHORIZED401tenant / Authorization / X-API-Key faltante, inválido o expirado
FORBIDDEN403El usuario no tiene el permiso requerido.
RATE_LIMITED429Se superó el límite de 10 req/min.
INTERNAL_ERROR500Error inesperado del servidor.