Ranking
Last updated
Was this helpful?
Last updated
Was this helpful?
The ranking service is used to retrieve the ranking of all drivers belonging to a group. This service returns the ranking of the current month and the previous month.
To be ranked, a driver must have completed at least 5 trips and travelled 20 km in a month.
The ranking of the current month is updated every 10 minutes.
The ranking of the previous month is frozen on the 1st day of the current month.
GET
https://service.drivequant.com/v3/drivekit/admin/drivers/ranking
Return drivers ranking for current and previous month
type*
String
Ranking type, can be safety, eco-driving, distraction, speeding
groupLabel
String
Group of drivers whose ranking is required. If not set, you get all drivers of your team.
DriveKit-Admin-API-Key*
String
Admin API Key
The table below summarizes the list of ranking data.
currentMonth
array[object]
previousMonth
array[object]
type
string
Ranking type set in the service call. Can be safety, eco-driving, distraction, speeding
MonthRanking contains the list of drivers in a group with their rank.
monthNumber
int
Month number of the ranking period (1 -> january, 2 -> february, ...)
driverRankedNumber
int
Number of ranked drivers
driverRanked
array[object]
driverNotRanked
array[object]
userId
string
Driver's unique identifier
firstname
string
Driver's firstname
lastname
string
Driver's lastname
pseudo
string
Driver's pseudo
rank
int
Driver's rank
score
double
Driver's score
distance
double
Monthly driving distance (in km)
tripNumber
double
Monthly number of trips
userId
string
Driver's unique identifier
firstname
string
Driver's firstname
lastname
string
Driver's lastname
pseudo
string
Driver's pseudo
distance
double
Monthly driving distance (in km)
tripNumber
double
Monthly number of trips
Drivers with their rank in the group in the current month (see )
Drivers with their rank in the group in the previous month (see )
List of ranked drivers (see )
List of unranked drivers (i.e. who have not driven the minimum distance and completed the minimum number of trips) (see )