Reporte de Alertas

Alertas generadas con detalles del evento, ubicación y canal de notificación.

GET/apidev/v1/reports/gt/alerts

PermisoAPICLI_RPTGT_ALERTAS

Límite de solicitudes10 req/min

Caché300s

Rango máximo31 días

---

Resumen

Devuelve las alertas generadas dentro de un rango de fechas, cada una con los detalles de su evento (grupo y código), el momento en que se generó y se notificó, el dispositivo y el conductor involucrados, la ubicación (dirección más coordenadas), y la velocidad y la temperatura en ese momento. Filtrá por dispositivos, códigos de evento o IDs de alerta específicos.

---

Solicitud

Encabezados de la solicitud

Every request to a protected endpoint requires these headers:

Header	Required	Description
Authorization	Yes	Bearer token obtained from the Login endpoint. Format: Bearer <token>
X-API-Key	Yes	Company integration key provided during onboarding. Format: gtk_xxx...
tenant	Yes	Your assigned tenant domain (default: geotareas.com) — always send your assigned tenant
Content-Type	Conditional	application/json — required for POST and PUT requests

Parámetros de consulta

Parámetro	Tipo	Requerido	Por defecto	Descripción
startdate	string	Sí	—	Fecha-hora de inicio en ISO 8601 (ej. 2026-03-01T00:00:00).
enddate	string	Sí	—	Fecha-hora de fin en ISO 8601. Rango máximo 31 días desde startdate.
devices	string	No	—	IDs de dispositivos separados por comas. Máximo 500.
events	string	No	—	Filtro de códigos de evento. Máximo 200 caracteres.
alert_ids	string	No	—	Filtro de IDs de alerta. Máximo 200 caracteres.
limit	integer	No	25	Cantidad de registros por página (1–100).
offset	integer	No	0	Cantidad de registros a omitir para la paginación.

---

Ejemplos de código

cURL

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

JavaScript

const res = await fetch(
  `https://${TENANT}/apidev/v1/reports/gt/alerts?startdate=2026-03-01T00:00:00&enddate=2026-03-15T23:59:59&limit=25`,
  {
    headers: {
      'Authorization': `Bearer ${TOKEN}`,
      'X-API-Key': APIKEY,
      'tenant': TENANT,
    },
  }
);
const data = await res.json();

Python

import requests

response = requests.get(
    f"https://{TENANT}/apidev/v1/reports/gt/alerts",
    headers={"Authorization": f"Bearer {TOKEN}", "X-API-Key": APIKEY, "tenant": TENANT},
    params={"startdate": "2026-03-01T00:00:00", "enddate": "2026-03-15T23:59:59", "limit": 25},
)
data = response.json()

---

Respuesta

Campos de la respuesta

Campo	Tipo	Descripción
alert_name	string	Nombre de la configuración de alerta.
event_group	string	Grupo/categoría del evento.
event_code	string	Código del evento.
generated_at	string | null	Marca de tiempo en que se generó la alerta.
sent_at	string | null	Marca de tiempo en que se envió la notificación.
device_name	string	Nombre del vehículo.
driver_name	string	Nombre del conductor.
address	string	Dirección de la ubicación.
latitude	number | null	Latitud.
longitude	number | null	Longitud.
speed	number	Velocidad al momento del evento (km/h).
temperature	number	Temperatura al momento del evento.
elapsed_time	string	Tiempo de permanencia dentro de la cerca que disparó la alerta, ya legible (ej. 1h 05m). Vacío cuando el evento no es de cerca.
geofences	string	Cercas involucradas en el evento, separadas por coma.
pois	string	Lugares especiales involucrados en el evento, separados por coma.
sensor1_label	string	Etiqueta de la lectura del sensor 1. Vacío cuando la compañía no usa el sensor 1.
sensor2_label	string	Etiqueta de la lectura del sensor 2. Vacío cuando la compañía no usa el sensor 2.
channel	string	Canal de notificación (email, sms, etc.).

Ejemplo de respuesta

{
  "success": true,
  "data": [
    {
      "alert_name": "Speed Limit",
      "event_group": "Velocity",
      "event_code": "117",
      "generated_at": "2026-03-05T14:22:15",
      "sent_at": "2026-03-05T14:22:18",
      "device_name": "Truck A-101",
      "driver_name": "Carlos Martinez",
      "address": "Ruta 1 km 45, San Jose",
      "latitude": -34.3426,
      "longitude": -56.7135,
      "speed": 118,
      "temperature": 22.5,
      "elapsed_time": "1h 05m",
      "geofences": "Deposito Central",
      "pois": "Estacion de servicio Ruta 1",
      "sensor1_label": "Puerta abierta",
      "sensor2_label": "",
      "channel": "email"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 25,
    "offset": 0
  }
}

---

Errores

Código	HTTP	Descripción
VALIDATION_ERROR	400	Parámetros inválidos: faltan fechas, rango > 31 días, valores de enum inválidos.
UNAUTHORIZED	401	tenant / Authorization / X-API-Key faltante, inválido o expirado
FORBIDDEN	403	El usuario no tiene el permiso requerido.
RATE_LIMITED	429	Se superaron las 10 req/min.
INTERNAL_ERROR	500	Error inesperado del servidor.

---

Relacionados

• Reporte de Tareas General
• Paginación