Saltar al contenido principal

Reporte de Detenido

Análisis del tiempo de inactividad del vehículo — inactividad con motor encendido y paradas con motor apagado, con contexto de geocercas y POIs.

GET/apidev/v1/reports/avl/idle
PermisoAPICLI_RPTAVL_DETENIDO
Límite de solicitudes10 req/min (ventana deslizante)
Caché300s (5 min)
Rango máximo31 días

Resumen

Desglose detallado de cada período en que un vehículo estuvo detenido, clasificado por estado de la ignición.

  • Filtrado por igniciónignition aísla la inactividad con motor encendido (desperdicio de combustible) de las paradas con motor apagado
  • Contexto de geocercageofences restringe a zonas específicas
  • Umbral de duraciónidle_min excluye paradas breves
  • Subtotalessubtotals=true para resúmenes agregados

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
startdatestringFecha-hora de inicio en ISO 8601
enddatestringFecha-hora de fin en ISO 8601. Rango máximo 31 días
devicesstringNoTodos los visiblesIDs de dispositivo separados por coma. Máximo 500
geofencesstringNoTodasIDs de geocerca separados por coma. Máximo 500
idle_minintegerNo0Tiempo mínimo de inactividad en minutos
ignitionenumNoFiltra por estado de la ignición: on (solo con ignición encendida), off (solo apagada). Omitido = todas las detenciones
subtotalsbooleanNofalseIncluye filas de subtotal
limitintegerNo25Registros por página (1100)
offsetintegerNo0Registros a omitir

Ejemplos de código

curl -s "https://$TENANT/apidev/v1/reports/avl/idle?startdate=2026-03-01T00:00:00&enddate=2026-03-15T23:59:59&limit=50&ignition=on" \
-H "Authorization: Bearer $TOKEN" \
-H "X-API-Key: $APIKEY" \
-H "tenant: $TENANT"

Campos de la respuesta

CampoTipoDescripción
device_namestringNombre visible del vehículo/dispositivo
person_namestringConductor asignado al momento del evento
datetime_startstring | nullMarca de tiempo de cuando comenzó el período de inactividad
datetime_endstring | nullMarca de tiempo de cuando terminó el período de inactividad
idle_minnumberDuración del período de inactividad en minutos
typestringEstado de la ignición durante la detención: Apagada / Encendida
addressstringDirección geocodificada inversa de la ubicación de inactividad
geofencesstringNombres de las geocercas dentro de las cuales cae la ubicación de inactividad. Cadena vacía si no hay
poisstringPuntos de interés cercanos. Cadena vacía si no hay

Ejemplo de respuesta

{
"success": true,
"data": [
{
"device_name": "Van B-205",
"person_name": "Carlos Medina",
"datetime_start": "2026-03-10T11:05:00",
"datetime_end": "2026-03-10T11:47:00",
"idle_min": 42,
"type": "Encendida",
"address": "Av. 18 de Julio 1234, Montevideo",
"geofences": "Client Zone A",
"pois": ""
},
{
"device_name": "Truck A-101",
"person_name": "",
"datetime_start": "2026-03-07T16:18:14",
"datetime_end": "2026-03-07T21:18:12",
"idle_min": 300,
"type": "Apagada",
"address": "Camino Carrasco 4500, Montevideo",
"geofences": "",
"pois": "Depósito Central"
}
],
"meta": {
"total": 38,
"limit": 50,
"offset": 0
}
}

Errores

CódigoHTTPDescripción
INVALID_DATE_RANGE400El rango de fechas supera el máximo de 31 días, el fin es anterior al inicio, o fechas no ISO
VALIDATION_ERROR400Parámetros inválidos: faltan fechas, valor de ignition inválido
UNAUTHORIZED401tenant / Authorization / X-API-Key faltante, inválido o expirado
FORBIDDEN403El usuario carece del permiso APICLI_RPTAVL_DETENIDO
RATE_LIMITED429Se superaron las 10 req/min
INTERNAL_ERROR500Error inesperado del servidor