post https://api.azuga.com/azuga-ws/v1/events.json
The Events API provides information on the different types of events occurring within your fleet. Events such as Speeding, Idling, Braking etc., are recorded and made available for use over an API. Every event is associated with an alert which gets triggered based on certain conditions. For example, a speeding alert gets triggered when a vehicle crosses 70 MPH (event).
This API returns information such as the vehicle name, alert name, alert type, and location. Information about more than one event can be obtained in a single API call. You can sort as well search for a particular information from the result set.
Sample Request
{
"vehicleIds":[
"94211ef5-8a1a-11e6-a876-d19d4bda3b40"
],
"eventType":"ALL",
"fromDate":"2016-10-03 00:00:00",
"toDate":"2016-10-05 23:59:59",
"searchCriteria":{
"columns":"vehicle",
"value":""
},
"sortCriteria":{
"column":"dateTime",
"sortDir":"DESC"
}
}
API Response Explanation
| Field | Description |
|---|---|
| code | API status code |
| message | API Message (Success/Failure) |
| reason | Reason for failure |
| generatedAtInMillis | API generation timestamp in UTC |
| events | Array object representing the meta data of the events |
| id | For internal Azuga use |
| dateTime | Timestamp, in milliseconds, at which the event was triggered |
| vehicle | Name of the vehicle for which the event was triggered |
| alertType | Type of alert which got triggered |
| alertName | Name of the alert |
| address | Address of the location at which the event occurred |
| group | Group to which the vehicle belongs to |
| parentGroup | Parent group of the vehicle group |
| foreParentGroup | Fore parent group of the vehicle group |
| isDeletedAlert | Boolean to indicate whether the alert was deleted or not |
| assetNo | Asset number of the vehicle |
| alertTypeId | Unique identifier representing the alert The alert type ID for each of the alerts is below: Speeding = 1 Stop_Time = 2 Idling = 3 Device_Plugged_In/Removed = 4 Unauthorized_Vehicle_Usage = 6 Braking = 7 Sudden_Acceleration = 8 Check_Engine_Light = 9 Vehicle_Not_Tracking = 10 Scheduled_Maintenance = 11 Low_Fuel = 13 Ignition = 14 Posted_Speed_Limit = 15 Low_Battery = 16 Cornering = 17 Panic = 18 Geofence = NULL Unknown_Driver = 20 Unauthorized_Occupant_Count = 21 Beacon_Unused = 22 |
| userId | Unique identifier representing the user |
| userName | Name of the user |
| lat | Latitude coordinate of the location at which the event occurred |
| lng | Longitude coordinate of the location at which the event occurred |
| displayTimezone | Timezone of the vehicle |
| offset | Value that is to be added or subtracted in order to get the correct timestamp |
| alertValue | Threshold value set for triggering the alert |
| settings | Configuration of the alert |
| vehicleId | Unique identifier representing the vehicle |
| distance | For Azuga internal use |
| driveTime | For Azuga internal use |
| vendorId | For Azuga internal use |
| gracePeriodAfterIgnitionOn | Time period (in seconds) after which the application checks if the vehicle is paired with a driver or not |
| noOfAllowedOccupants | Number of occupants allowed in a vehicle |
| noOfDetectedOccupants | Number of occupants detected in a vehicle |
| occupants | Number of beacons |
| noOfDays | Number of days set as the threshold for triggering a beacon unused alert |
| beaconMacAddress | MAC address of the beacon |
| beaconUnusedFrom | Time period after which the beacon was left unused |
| beaconUnusedTill | Time period up to which the beacon was left unused |
| serialNumber | Serial number of the beacon |
| mode | Frequency of the alert email 1 - Instant 2 - Hourly |
| reminderFreq | How often the alert is to be sent |
| customerId | Unique identifier representing the customer |
| deviceType | Type of device 1 - Azuga Device 2 - Mobile App |
| deletedAlert | Boolean representing whether the associated alert is deleted. True = Deleted False = Not deleted |
| alertTypePropertyKey | For Azuga Internal use |
| number | For Azuga Internal use |
| jobId | For Azuga Internal use |
| toEmail | Email address of the users who should be in "To" list and are configured in the alert |
| ccEmail | Email address of the users who should be in "CC" list and are configured in the alert |
| fenceId | Unique identifier representing the geofence |
| fenceName | Name of the geofence |
| startLandmarkId | Unique identifier representing the start landmark |
| endLandmarkId | Unique identifier representing the end landmark |
| startLandmarkName | Name of the start landmark |
| endLandmarkName | Name of the end landmark |
| eventTypeId | Unique identifier representing the event type |
| alertKey | For Azuga Internal use |