Skip to main content

Generated Alerts Report

System-generated alerts with event details, location, speed, temperature, and notification channel.

GET/apidev/v1/reports/general/generated-alerts
PermissionAPICLI_RPTGRAL_ALERTAS
Rate Limit10 req/min
Cache300s
Max Range31 days

Overview​

Returns the alerts the system generated over the selected period, each with its event details, the device and driver involved, the location and speed at the moment, any temperature reading, and the channel the notification was sent through. Use it to audit triggered alerts and how they were delivered.

  • Device filter — devices limits results to specific units
  • Alert filter — alert_ids narrows results to specific alert configurations
  • Event grouping — event_group filters by event category

Request​

Request Headers​

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

Query Parameters​

ParameterTypeRequiredDefaultDescription
startdatestringYes—ISO 8601 start date-time (e.g. 2026-03-01T00:00:00).
enddatestringYes—ISO 8601 end date-time. Max range 31 days from startdate.
devicesstringNoAll visibleComma-separated device IDs. Max 500.
alert_idsstringNo—Comma-separated alert configuration IDs. Max length 200.
event_groupstringNo—Event group filter. Max length 200.
limitintegerNo25Number of records per page (1–100).
offsetintegerNo0Number of records to skip for pagination.

Code Examples​

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"

Response​

Response Fields​

FieldTypeDescription
alert_namestringAlert configuration name.
event_groupstringEvent group/category.
event_codestringEvent code.
generated_atstring | nullGeneration timestamp.
sent_atstring | nullNotification sent timestamp.
device_namestringVehicle name.
driver_namestringDriver name.
addressstringLocation address.
latitudenumber | nullLatitude.
longitudenumber | nullLongitude.
speednumberSpeed at event (km/h).
temperaturenumberTemperature at event.
elapsed_timestringTime spent inside the geofence that triggered the alert, already human-readable (e.g. 1h 05m). Empty when the event is not geofence-based.
geofencesstringGeofences involved in the event, comma-separated.
poisstringPoints of interest involved in the event, comma-separated.
sensor1_labelstringSensor 1 reading label. Empty when the company does not use sensor 1.
sensor2_labelstringSensor 2 reading label. Empty when the company does not use sensor 2.
channelstringNotification channel.

Example Response​

{
"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
}
}

Errors​

CodeHTTPDescription
VALIDATION_ERROR400Invalid parameters (e.g. date range exceeds 31 days).
UNAUTHORIZED401Missing, invalid, or expired tenant / Authorization / X-API-Key
FORBIDDEN403User lacks required permission.
RATE_LIMITED429Exceeded 10 req/min.
INTERNAL_ERROR500Unexpected server error.