Reporte de Alertas Generadas

Alertas generadas por el sistema con detalles del evento, ubicación, velocidad, temperatura y canal de notificación.

GET/apidev/v1/reports/general/generated-alerts

PermisoAPICLI_RPTGRAL_ALERTAS

Límite de solicitudes10 req/min

Caché300s

Rango máximo31 días

Resumen

Devuelve las alertas que el sistema generó durante el período seleccionado, cada una con los detalles de su evento, el dispositivo y el conductor involucrados, la ubicación y la velocidad en el momento, cualquier lectura de temperatura y el canal por el que se envió la notificación. Úsalo para auditar las alertas disparadas y cómo se entregaron.

Filtro por dispositivo — devices limita los resultados a unidades específicas
Filtro de alerta — alert_ids acota los resultados a configuraciones de alerta específicas
Agrupación por evento — event_group filtra por categoría de evento

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	Predeterminado	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	Todos los visibles	IDs de dispositivo separados por coma. Máximo 500.
`alert_ids`	string	No	—	IDs de configuración de alerta separados por coma. Longitud máxima 200.
`event_group`	string	No	—	Filtro por grupo de evento. Longitud máxima 200.
`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
JavaScript
Python

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

const res = await fetch(
  `https://${TENANT}/apidev/v1/reports/general/generated-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();

import requests

response = requests.get(
    f"https://{TENANT}/apidev/v1/reports/general/generated-alerts",
    headers={"Authorization": f"Bearer {token}", "X-API-Key": api_key, "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 de evento.
`generated_at`	string \| null	Marca de tiempo de generación.
`sent_at`	string \| null	Marca de tiempo de envío de 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 en el evento (km/h).
`temperature`	number	Temperatura en el 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.

Ejemplo de respuesta

{
  "success": true,
  "data": [
    {
      "alert_name": "Urban Speed Limit",
      "event_group": "speed_violation",
      "event_code": "SPD-001",
      "generated_at": "2026-03-05T14:22:00",
      "sent_at": "2026-03-05T14:22:05",
      "device_name": "Unit-105",
      "driver_name": "Carlos Martinez",
      "address": "Av. Reforma 1234, Col. Centro",
      "latitude": 19.4326,
      "longitude": -99.1332,
      "speed": 95,
      "temperature": 22.5,
      "elapsed_time": "1h 05m",
      "geofences": "Deposito Central",
      "pois": "Estacion de servicio Ruta 1",
      "sensor1_label": "Puerta abierta",
      "sensor2_label": "",
      "channel": "email"
    },
    {
      "alert_name": "Cold Chain Max Temperature",
      "event_group": "temperature_alarm",
      "event_code": "TEMP-003",
      "generated_at": "2026-03-06T06:15:00",
      "sent_at": "2026-03-06T06:15:02",
      "device_name": "Unit-310",
      "driver_name": "Miguel Torres",
      "address": "Central de Abastos, Iztapalapa",
      "latitude": 19.3900,
      "longitude": -99.1500,
      "speed": 0,
      "temperature": 8.5,
      "elapsed_time": "1h 05m",
      "geofences": "Deposito Central",
      "pois": "Estacion de servicio Ruta 1",
      "sensor1_label": "Puerta abierta",
      "sensor2_label": "",
      "channel": "sms"
    }
  ],
  "meta": {
    "total": 2,
    "limit": 25,
    "offset": 0
  }
}

Errores

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

Resumen​

Solicitud​

Encabezados de la solicitud​

Parámetros de consulta​

Ejemplos de código​

Respuesta​

Campos de la respuesta​

Ejemplo de respuesta​

Errores​

Relacionado​