Event Videos

post

https://services.azuga.com/azuga-ws-oauth/v3/eventVideos.json

This API allows you to view the details of the event videos generated for your account between a specified timeframe. You are allowed to filter the result by adding vehicleId or userId(driverId) & event type in the request body. The body parameters vehicleId or userId(driverId) is a mandatory parameter. Each page will have 50 records each by default.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Sample Request
https://services.azuga.com/azuga-ws-oauth/v3/eventVideos.json

{
    "eventTypes": "CAM_BUTTON_PRESSED,CAM_DISTRACTED_DRIVING,CAM_EATING_DRINKING,CAM_PHONE_USE,CAM_TAMPERED,CAM_UNBELTED,CAM_VIOLENT_LEFT_TURN,CAM_VIOLENT_RIGHT_TURN,HARD_ACCELERATION_MESSAGE,HARD_BREAKING_MESSAGE,HARD_CORE_BRAKING_MESSAGE,REQUESTED_MESSAGE,CAM_ACCIDENT_AI,CAM_GFORCE_HIGH,CAM_GFORCE_REGULAR,CAM_POSSIBLE_FATIGUE,CAM_OBSTRUCTION",
    "selectAll": false,
    "vehiclesIds": "b9832540-8b65-11ec-91dd-0d84087e6e9b,7735a26d-e554-11ec-9366-7dccafc455d7,d396c620-94c3-11ec-b997-83862b04203f,cce7a04c-59e4-11ec-90ce-5995d834178a",
    "endTime": "2023-02-20 11:59:59 PM",
    "startTime": "2023-02-14 12:00:00 AM",
    "page": 1,
    "userIds": "",
    "onlyRisky": false,
    "onlyTagged": true,
    "events": "obstruction",
    "limit":80
}

{
  "requestedVideoId": "01c7d599-bb52-11ee-9eea-0f399c55811e"
}

{
  "eventVideoIdInString": "5380BCC84ECFA337852AFD5031B3F323"
}

API Response explanation

Field	Description	Data Type
generatedAtInMillis	API generation timestamp in UTC	Long
data	Object representing the meta data of the event videos	Object
eventVideoId	Unique identifier representing the event	String
customerId	Unique identifier representing the customer - For internal use	long
locationStoreId	Unique identifier representing the event	String
lat	Latitude of the location	Double
lon	Longitude of the location	Double
obdSpeed	For internal Azuga use	Integer
obdMaxSpeed	For internal Azuga use	Integer
obdAverageSpeed	For internal Azuga use	Integer
address	Address of the event location	String
eventType	Name of the event type	String
deviceId	Unique identifier representing the device	String
deviceTimezone	Timezone of the device	String
devicetzUpdatedAt	Timezone updated timestamp in UTC milliseconds	Date
serialNum	Serial number of the device	String
vehicleId	Unique identifier representing the vehicle - For internal Azuga use	String
vehicleName	Name of the vehicle	String
userId	Unique identifier representing the driver - For internal Azuga use	String
firstName	First name of the driver	String
lastName	Last name of the driver	String
groupId	Unique identifier representing the group	String
groupname	Name of the group	String
parentGroupId	Parent group of the child group. For internal Azuga use	String
parentGroupname	Parent group name of the child group. For internal Azuga use	String
foreparentGroupId	Fore parent group of the child group. For internal Azuga use	String
foreparentGroupName	Fore parent group name of the child group. For internal Azuga use	String
dashcamType	For internal Azuga use	String[]
eventTime	Event time in UTC milliseconds	Date
eventEndTime	For internal Azuga use	Date
createdAt	For internal Azuga use	Date
tripDistance	For internal Azuga use	Double
fixQuality	For internal Azuga use	Integer
vendorId	Unique identifier representing the vendor - For internal Azuga use	Integer
lensId	For internal Azuga use	Integer
requestedVideo	Object representing the metadata of the requested video	Object
requestedVideoName	Name of the requested video	String
userId	Unique identifier representing the driver	String
firstName	First name of the driver	String
lastName	Last name of the driver	String
requestedVideoId	Unique identifier representing the requested video. This id can be used to filter the data using the body parameter - 'requestedVideoId' in successive requests	String
badge	For internal Azuga use	EventVideoBadge[]
videoLinkAvailable	For internal Azuga use	Boolean
badgeAccurate	For internal Azuga use	Boolean
updatedAt	For internal Azuga use	Date
comments	For internal Azuga use	String
categoryNames	For internal Azuga use	String
status	The current status of the requested video. This filed is applicable only for video type is requested video. The valid inputs are 1 - Request submitted by the user, 2 - Request sent to the AI Camera, 3 - Camera is offline, 4 - Camera confirms video is not available, 5 - Camera confirms video is available, 6 - At least one video retrieved, 7 - All Videos retrieved	Integer
videoLinks	Object representing the video link information	Lis`<List<VideoLink>>`
videoIndex	Index of the video 1 = Road facing 2 = Driver facing	Integer
videoName	Name of the video; Road/Driver facing.	String
videoLink	URL of the video	String
thumbnailLink	URL of the thumbnail	String
speed	Initial speed of the vehicle in Kph	Integer
maxSpeed	Final speed of the vehicle in Kph	Integer
displayTimeZone	Timezone of the vehicle	String
offset	Difference of time in milliseconds from UTC timezone	Integer
confirmedRisky	For internal Azuga use	boolean
deleted	For internal Azuga use	boolean
deletedAt	For internal Azuga use	Date
eventVideoIdInString	Unique identifier representing the event video. This id can be used to filter the data using the body parameter - 'eventVideoIdInString' in successive requests	String

Query Params

videoType

string

This field filters the data based on the type of the video. The valid inputs are: 1. requestedVideo, 2. eventVideo

Body Params

startTime

date-time

required

Start time of the event video you would like to generate in 'YYYY-MM-DD hh:mm:ss a' format

endTime

date-time

required

End time of the event video you would like to generate in 'YYYY-MM-DD hh:mm:ss a; format

page

int32

required

Page number of the result set. By default, one page will have 50 records.

eventTypes

string

Type of events the result set to be filtered out. Valid eventTypes are CAM_BUTTON_PRESSED,CAM_DISCONNECT,CAM_DISTRACTED_DRIVING,CAM_EATING_DRINKING,CAM_IMPACT,CAM_PHONE_USE,CAM_SMOKING,CAM_TAMPERED,CAM_UNBELTED,CAM_VIOLENT_LEFT_TURN,CAM_VIOLENT_RIGHT_TURN,HARD_ACCELERATION_MESSAGE,HARD_BREAKING_MESSAGE,HARD_CORE_BRAKING_MESSAGE,REQUESTED_MESSAGE,CAM_ACCIDENT_AI,CAM_GFORCE_HIGH,CAM_GFORCE_REGULAR,CAM_POSSIBLE_FATIGUE,CAM_TAILGATING,CAM_OBSTRUCTION,CAM_LANE_DEPARTURE

selectAll

boolean

Set this value to True if the result set needs to be included with all event type videos.

vehiclesIds

string

Unique identifier representing the vehicles to be filtered in the result set. Set this to null ("vehiclesIds":"") to add all vehicles

userIds

string

Unique identifier representing the drivers to be filtered in the result set

onlyRisky

boolean

Set this to true if the result set needs to be filtered with "Videos Worth Watching". By default, this field is set to false

onlyTagged

boolean

Set this to true if the result set needs to be filtered with "Tagged Videos". By default, this field is set to false

events

string

This represents the different type of tag that is associated with the event video. The parameter "onlyTagged" should be set to True for this field to be active. Valid values are obstruction, inattention(not focussed), phone(Using phone), rash_driving(Rash driving) and accident. Set this field to null ("") if you would like to see all tag videos.

status

int32

This field helps to filter the result data based on the status of the requested video. This is applicable only for the query parameter videotype=requestedVideo. The valid inputs for vendorId = 14(Safetycam) are 1 - Request submitted by the user, 4 - Camera confirms video is not available or not able to retrieve it after trying for one month, 6 - At least one video retrieved and for vendorId = 15(Azuga AI Camera) are 1 - Request submitted by the user, 2 - Request sent to the AI Camera, 3 - Camera is offline, 4 - Camera confirms video is not available or not able to retrieve it after trying for one month, 5 - Camera confirms video is available, 6 - At least one video retrieved, 7 - All Videos retrieved

limit

int32

The number of records to be retrieved in one page. By default, the value of this field is 50. We are allowed to increase the limit upto 100.

requestedVideoId

string

Unique identifier representing requested video. This field can be added if you would like to filter the data using the identifier of requested video. This is valid only when the query parameter videoType=1.

eventVideoIdInString

string

Unique identifier representing event video. This field can be added if you would like to filter the data using the identifier of event video. This is valid only when the query parameter videoType=2.

Responses

Sample Request

API Response explanation

200200

400400