Saltar al contenido principal

Reporte de Ubicación en Vivo

Analítica de uso de los enlaces de seguimiento — creación, aperturas y cantidad de respuestas.

GET/apidev/v1/reports/gt/live-location
PermisoAPICLI_RPTGT_LIVELOCATION
Límite de solicitudes10 req/min
Caché300s
Rango máximo31 días

Resumen

Devuelve la analítica de uso de los enlaces de seguimiento compartidos con los clientes finales dentro de un rango de fechas — cuántos enlaces se crearon, se abrieron, se usaron y obtuvieron respuesta, junto con la cantidad de receptores únicos. Usá group_by para agregar por día, producto, causa o dispositivo, y filtrá por dispositivos, conductores, tipos de servicio, causas o geografía.


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
startdatestringFecha-hora de inicio en ISO 8601 (ej. 2026-03-01T00:00:00).
enddatestringFecha-hora de fin en ISO 8601. Rango máximo 31 días desde startdate.
devicesstringNoIDs de dispositivos separados por comas. Máximo 500.
driversstringNoIDs de conductores separados por comas. Máximo 500.
service_typesstringNoIDs de tipos de servicio separados por comas. Máximo 100.
causesstringNoIDs de causas separados por comas. Máximo 100.
countriesstringNoIDs de países separados por comas. Máximo 50.
departmentsstringNoIDs de departamentos separados por comas. Máximo 50.
group_byenumNodayModo de agrupación: day, product, cause, device.
limitintegerNo25Cantidad de registros por página (1100).
offsetintegerNo0Cantidad de registros a omitir para la paginación.

Ejemplos de código

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

Respuesta

Campos de la respuesta

CampoTipoDescripción
task_numberstring | nullNúmero de tarea.
product_namestringNombre del producto.
product_typestringTipo de producto.
service_typestringTipo de servicio.
causestringNombre de la causa.
device_namestringNombre del vehículo.
created_countnumberEnlaces creados.
used_countnumberEnlaces usados.
receiver_countnumberReceptores únicos.
hashstringHash del enlace de seguimiento.
total_linksnumberTotal de enlaces generados.
unopenednumberEnlaces no abiertos.
openednumberEnlaces abiertos.
datestring | nullFecha (cuando se agrupa por día).
response_countnumberRespuestas recibidas.

Ejemplo de respuesta

{
"success": true,
"data": [
{
"task_number": "104820580001",
"product_name": "Installation",
"product_type": "Field",
"service_type": "Maintenance",
"cause": "Scheduled",
"device_name": "Truck A-101",
"created_count": 3,
"used_count": 2,
"receiver_count": 1,
"hash": "abc123",
"total_links": 3,
"unopened": 1,
"opened": 2,
"date": "2026-03-05",
"response_count": 1
}
],
"meta": {
"total": 1,
"limit": 25,
"offset": 0
}
}

Errores

CódigoHTTPDescripción
VALIDATION_ERROR400Parámetros inválidos: faltan fechas, rango > 31 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 superaron las 10 req/min.
INTERNAL_ERROR500Error inesperado del servidor.