Challenge ranking
Last updated
Was this helpful?
Last updated
Was this helpful?
This service returns the list of all the users registered to the challenge, along with their rankings and ranking details (i.e., number of trips and total distance driven during the challenge).
If the challenge has not yet started, the service will return a HTTP 204 (no body) response, along with a Retry-After header containing the date at which the response will be available:
The usersRanked list contains the list of all registered users who have met the requirements for the challenge. These users have a rank, and a score.
The usersNotRanked list contains the list of registered users who have not yet met the requirements, but who might already have started accumulating challenge data. The users do not have a score yet, but their number of trips and distance driven are returned in order to evaluate their progress.
If the challenge only concerns a specific group (or groups), then the service also accepts a group request parameter to retrieve the rankings for a single group. If no value is provided, then the global ranking is returned.
The table below summarizes the elements included in the ChallengeRankingsResponse object.
challengeId
string
Unique identifier of the challenge
group
string
If present, indicates that the rankings are specific for this group label
conditions
Conditions that need to be filled for a user to be ranked
registeredUsers
int
Total number of users registered to the challenge
rankedUsers
int
Total number of users ranked in the challenge
totalDistance
int
Total distance driven by the users for the challenge
totalNumberTrips
int
Total number of trips made by the users for the challenge
usersNotRanked
array[object]
usersRanked
array[object]
The table below summarizes the elements included in the ChallengeConditions object.
km
int
Minimum distance required to be ranked (in km)
nbTrip
int
Minimum number of trips required to be ranked
The table below summarizes the elements included in the UserNotRanked object.
username
string
Unique identifier of the user
firstname
string
First name of the user
lastname
string
Last name of the user
registerDate
string
Date at which the user entered the challenge
Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
numberTrips
int
Number of trips since the user registered to the challenge
distance
int
Distance since the user registered to the challenge
The table below summarizes the elements included in the UserRanked object.
username
string
Unique identifier of the user
firstname
string
First name of the user
lastname
string
Last name of the user
registerDate
string
Date at which the user entered the challenge
Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
numberTrips
int
Number of trips since the user registered to the challenge
distance
int
Distance since the user registered to the challenge
rank
int
Current rank of the user
score
double
Score of the user during the challenge
List of users not ranked in the challenge (see )
List of users ranked in the challenge (see )
Unique identifier of the challenge
For SINGLE_GROUP and MULTIPLE_GROUPS challenge only: if specified, get the rankings for this specific group label only
Drivekit Admin API key