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

Request

Query Parameters

ParameterTypeRequiredDefaultDescription
startdatestringYesISO 8601 start date-time (e.g. 2026-03-01T00:00:00).
enddatestringYesISO 8601 end date-time. Max range 31 days from startdate.
devicesstringNoAll visibleComma-separated device IDs. Max 500.
alert_idsstringNoComma-separated alert configuration IDs. Max length 200.
event_groupstringNoEvent group filter. Max length 200.
limitintegerNo25Number of records per page (1100).
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.
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,
"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,
"channel": "sms"
}
],
"meta": {
"total": 2,
"limit": 25,
"offset": 0
}
}

Errors

CodeHTTPDescription
BAD_REQUEST400Missing required headers.
VALIDATION_ERROR400Invalid parameters (e.g. date range exceeds 31 days).
UNAUTHORIZED401Invalid or expired JWT / API Key.
FORBIDDEN403User lacks required permission.
RATE_LIMITED429Exceeded 10 req/min.
INTERNAL_ERROR500Unexpected server error.