Users' progress
Last updated
Was this helpful?
Last updated
Was this helpful?
This service returns the list of the users registered to the challenge, who were ranked and had enough data before the challenge started (i.e., has made at least 10 trips during the pre-challenge period).
The service returns their progress (i.e. score comparison before and during the challenge) and all the ranking details (number of trips, distance, score). The list is sorted from best to worst progression.
If the challenge has not yet finished, 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:
If the challenge only concerns a specific group (or groups), then the service also accepts a group request parameter to retrieve the progressions for a single group. If no value is provided, then the global progressions are returned.
The table below summarizes the elements included in the ChallengeProgressResponse object.
challengeId
string
Unique identifier of the challenge
group
string
If present, indicates that the rankings are specific for this group label
registeredUsers
int
Total number of users registered to the challenge
rankedUsers
int
Total number of users ranked in the challenge
usersWithDataBefore
int
Total number of users who have enough data before the challenge started
totalDistance
int
Total distance driven by the users for the challenge
totalNumberTrips
int
Total number of trips made by the users for the challenge
users
array[object]
The table below summarizes the elements included in the UserRankedWithProgress 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
scoreBefore
double
Score of the user during the pre-challenge period
scoreEvolution
double
Evolution of the score of the user (i.e., effect of the challenge on the user's score)
List of users ranked in the challenge with enough data before the challenge (see )
Unique identifier of the challenge
Drivekit Admin API key