Events

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Sample Request

https://api.azuga.com/azuga-ws/v1/events.json

{  
   "eventType":"Ignition",
   "fromDate":"1454284800000",
   "toDate":"1455580799000",
   "sortCriteria":{  
      "column":"vehicle",
      "sortDir":"ASC"
   },
   "startIndex":0,
   "limit":100
}

API Response Explanation

FieldDescription
codeAPI status code
messageAPI Message (Success/Failure)
reasonReason for failure
generatedAtInMillisAPI generation timestamp in UTC
dateTimeTimestamp, in milliseconds, at which the event was triggered
vehicleName of the vehicle for which the event was triggered
alertTypeType of alert which got triggered
alertNameName of the alert
addressAddress of the location at which the event occurred
groupGroup to which the vehicle belongs to
parentGroupParent group of the vehicle group
foreParentGroupFore parent group of the vehicle group
isDeletedAlertBoolean to indicate whether the alert was deleted or not
assetNoAsset number of the vehicle
alertTypeIdUnique 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
  • Hard_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
userIdUnique identifier representing the user
userNameName of the user
latLatitude coordinate of the location at which the event occurred
lngLongitude coordinate of the location at which the event occurred
displayTimezoneTimezone of the vehicle
offsetValue that is to be added or subtracted in order to get the correct timestamp
alertValueThreshold value set for triggering the alert
ignitionOffTimeTimestamp at which the vehicle ignition was turned OFF
settingsConfiguration of the alert
trackingTypeTracking interval i.e. 24*7 or custom hours set
Body Params
string
Defaults to ALL

Type of events separated by commas. The following values are valid: Speeding, Stop_Time Idling, Device_Plugged_In/Removed, Unauthorized_Vehicle_Usage, Hard_Braking, Sudden_Acceleration, Check_Engine_Light, Vehicle_Not_Tracking, Scheduled_Maintenance, Low_Fuel Ignition, Posted_Speed_Limit, Low_Battery, Cornering, Panic, Geofence

string
required

Include events which have triggered after this timestamp. Timestamp (GMT) in milliseconds or ‘YYYY-mm-dd HH:mm:ss’ format

string
required

Include events which have triggered before this timestamp. Timestamp (GMT) in milliseconds or ‘YYYY-mm-dd HH:mm:ss’ format

sortCriteria
array

Sort results in ascending or descending order. By default, results get sorted in ascending order based on the event time

sortCriteria
int32

Index of the first result to return (per page)

int32

Maximum number of results to return per page

string

Search results based on a value for a specified column. Pass value as ALL to search across all columns

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json