getDriverBehavior

get

Return driving behavior and utilization information on a specific driver. Response is capped at 30 days, when start and end dates provided exceed the limit, information on the latest 30 days will be provided.

Ex. when start date is 2018-01-01 and end date is 2018-02-20, information is returned from 2018-01-21 to 2018-02-20.

Resource URL

https://api-sandbox.arity.com/shared-mobility-insights/v1/drivers/{driverId}/behavior

Query Parameters

Name	Values	Description
startDate (required)		Start date (inclusive) of the driver behavior requested. In YYYY-MM-DD format.
endDate (required)		End date (inclusive) of the driver behavior requested. In YYYY-MM-DD format.

Header Parameters

Name	Values	Description
Authorization (required)		Value should be the word Bearer followed by a space and then the token (e.g., Bearer CW8abh5JkxZ5KYdAQQH0p9fTAicq). To generate a token, use the OAuth API.

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Reset

Request Response cURL

Make a request and see the response.

Response Error Details

HTTP Code

Error Code

Description
400

400

Bad Request response
401

401

Unauthorized response
500

500

Server Error response

Resource Summary
Security	None
Category	Risks & Utilization Insights

Request
Response

Name	Type	Description

Name	Type	Description
driverId	string	ID of the driver.
startDate	string	Start date (inclusive) of the driver behavior requested. In YYYY-MM-DD format.
endDate	string	End date (inclusive) of the driver behavior requested. In YYYY-MM-DD format.
driverCoaching .performanceRating	number	The rating on driving performance of a driver, ranges from 1 to 100.
driverCoaching .daysSinceLastTrip	number	The number of the day(s) since the driver took a trip.
driverCoaching .coachingCategory	string	The type of coaching the driver needs, ex. Speeding.
driverCoaching .coachingText	string	The pre-made coaching text can be sent to the driver to improve their driving and reduce risks.
dailyBehavior	array	A list of behavior data of drivers by date.
dailyBehavior[] .behavior	array	Utilization in that specific date by different vehicles.
dailyBehavior[] .behavior[] .vin	string	ID of the vehicle.
dailyBehavior[] .behavior[] .miles	number	The number of miles driven using this vehicle.
dailyBehavior[] .behavior[] .drivingHours	number	The number of hours driven using this vehicle.

Working...