This API allows the user to generate a detailed report on all alert types.
{
"index": 0,
"size": 100,
"desc": true,
"sortField": "dateTime",
"filter": {
"orFilter": {
"vehicleId": [
"bef7148c-dd18-11ec-87d5-a71b2bdfc1ca"
],
"beaconMacAddress": [
"FF7E34C450DA"
]
},
"matchFilter": {}
},
"startDate": "2022-10-12T04:00:00.000Z",
"endDate": "2022-10-19T03:59:59.676Z",
"alertTypeId": -1,
"browserTimezone": "US/Eastern"
}
API Response explanation
Field | Description | Data Type |
---|---|---|
generatedAtInMillis | Time at which the API returns the result. The time is in milliseconds. | Long |
id | Unique identifier of the alert record | String |
alertName | Name of the alert | String |
customerId | Unique identifier of the customer | long |
alertId | Unique identifier of the alert | String |
alertTypeId | Unique identifier of the alert type 1 Speeding | Int |
alertConfigValue | Alert configuration value depending on the alertTypeId | String |
duration | Duration of the alert sustained in milliseconds | Long |
peakSpeed | Highest speed attained by the vehicle in kph | float |
avgSpeed | Average speed attained by the vehicle in kph | float |
initialSpeed | Initial speed of the vehicle in kph | float |
finalSpeed | Final speed of the vehicle in kph | float |
address | Address of the location | String |
dateTime | Timestamp in UTC timezone | Date |
userName | Name of the driver | String |
userId | Unique identifier representing the driver | String |
lat | Latitude of the location | Double |
lng | Longitude of the location | Double |
parentGroup | Name of the parent group | String |
deviceId | Unique identifier representing the device | String |
deviceSerialNumber | Serial number of the device | String |
deviceTimezone | Timezone of the device | String |
assetno | Asset number of the vehicle | String |
vehicle | Name of the vehicle | String |
vehicleId | Unique identifier representing the vehicle | String |
group | Name of the group | String |
groupId | Unique identifier representing the group | String |
speed | Speed of the vehicle in Kms | float |
postedSpeedLimit | Posted speed limit of the road in Kms | Int |
durationFormatted | Duration in hh:mm:ss format | String |
startTimeSetting | Start time to track the vehicle | String |
endTimeSetting | End time to track the vehicle | String |
lastContactTimeFormatted | Last contact time in vehicle/device timezone | String |
lastContactTime | Last contact time in UTC timezone | Date |
mode | Alert mode configured in the alert section 1 - Indicates that the alert is triggered instantly | int |
noOfDays | Number of days the beacon is unused | int |
gracePeriodAfterIgnitionOn | Grace period configured after the ignitionON before the alert can trigger | int |
alertType | Name of the alert type | boolean |
maxOccupants | Maximum number of occupants in the vehicle | int |
detectedOccupants | Number of occupants detected in the vehicle | int |
deviceType | Unique identifier representing the type of the device
| boolean |
dateTimeInDTZ | Timestamp in device timezone | Date |
displayTime | Timestamp in device timezone in YYYY-MM-DD HH:mm:ss:SSS format | String |
firstPostedSpeedLimit | First posted speed limit of the alert duration in kph | float |
averagePostedSpeedLimit | Average posted speed limit of the alert duration in kph | float |
beaconAsVehicleId | For Azuga internal use | boolean |
hcb | For Azuga internal use | boolean |
error | Displays the corresponding error message which occurs during API compilation. | List |