Skip to main content

Speed Report

Overspeed events across your fleet — location, speed, duration, and optional radar proximity data.

GET/apidev/v1/reports/avl/speed
PermissionAPICLI_RPTAVL_VELOCIDAD
Rate Limit10 req/min (sliding window)
Cache300s (5 min)
Max Range31 days

Overview

Identifies all instances where a vehicle exceeded a given speed threshold. Each overspeed event is recorded with its location, speed, and optional radar proximity.

  • Custom thresholdspeed_threshold defines the speed limit for detection (default 80 km/h)
  • Duration filteringduration_min excludes brief speed spikes
  • Radar enrichmentradars=true includes nearby radar/speed-camera POIs
  • Subtotalssubtotals=true for aggregated summaries

Query Parameters

ParameterTypeRequiredDefaultDescription
startdatestringYesISO 8601 start date-time (e.g. 2026-03-01T00:00:00)
enddatestringYesISO 8601 end date-time. Max range 31 days
devicesstringNoAll visibleComma-separated device IDs. Max 500
speed_thresholdintegerNo80Speed threshold in km/h (1300). Events above this are reported
duration_minintegerNo0Minimum overspeed duration in minutes. Shorter events are excluded
subtotalsbooleanNofalseInclude subtotal rows
radarsbooleanNofalseInclude nearby radar/speed-camera POI data
limitintegerNo25Records per page (1100)
offsetintegerNo0Records to skip

Code Examples

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

Response Fields

FieldTypeDescription
device_namestringDisplay name of the vehicle/device
person_namestringName of the assigned driver at the time of the event
datetimestring | nullTimestamp when the overspeed event was recorded
addressstringReverse-geocoded address where the event occurred
speednumberSpeed recorded at the event (km/h)
max_speednumberMaximum speed configured for the vehicle (km/h)
stepstringDuration or step description of the overspeed event
poisstringNearby radar/speed-camera POIs (when radars=true). Empty string when disabled or no POIs found
speed vs max_speed

speed is the actual speed recorded during the event. max_speed is the speed limit configured in the vehicle's settings — useful for comparing how much the driver exceeded their own vehicle's threshold.

Example Response

{
"success": true,
"data": [
{
"device_name": "Sedan C-310",
"person_name": "Ana Lopez",
"datetime": "2026-03-07T14:22:15",
"address": "Ruta 1 km 45, San Jose",
"speed": 118,
"max_speed": 110,
"step": "4m 05s",
"pois": "Radar Km 44 (320m)"
},
{
"device_name": "Truck A-101",
"person_name": "Carlos Martinez",
"datetime": "2026-03-07T16:10:33",
"address": "Av. Italia 2800, Montevideo",
"speed": 95,
"max_speed": 80,
"step": "1m 12s",
"pois": ""
}
],
"meta": {
"total": 23,
"limit": 50,
"offset": 0
}
}

Errors

CodeHTTPDescription
BAD_REQUEST400Missing required headers
VALIDATION_ERROR400Invalid params: missing dates, range > 31 days, speed_threshold outside 1–300, limit > 100
UNAUTHORIZED401Invalid or expired JWT / API Key
FORBIDDEN403User lacks APICLI_RPTAVL_VELOCIDAD permission
RATE_LIMITED429Exceeded 10 req/min
INTERNAL_ERROR500Unexpected server error