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
{
"eventType":"Ignition",
"fromDate":"1454284800000",
"toDate":"1455580799000",
"sortCriteria":{
"column":"vehicle",
"sortDir":"ASC"
},
"startIndex":0,
"limit":100
}API Response Explanation
Field | Description |
|---|---|
code | API status code |
message | API Message (Success/Failure) |
reason | Reason for failure |
generatedAtInMillis | API generation timestamp in UTC |
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
|
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 |
ignitionOffTime | Timestamp at which the vehicle ignition was turned OFF |
settings | Configuration of the alert |
trackingType | Tracking interval i.e. 24*7 or custom hours set |