Users' progress
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.
If you have your admin API key, you can try the API via this link.
Response
The table below summarizes the elements included in the ChallengeProgressResponse
object.
Field | Type | Description |
---|---|---|
challengeId |
| Unique identifier of the challenge |
group |
| If present, indicates that the rankings are specific for this group label |
registeredUsers |
| Total number of users registered to the challenge |
rankedUsers |
| Total number of users ranked in the challenge |
usersWithDataBefore |
| Total number of users who have enough data before the challenge started |
totalDistance |
| Total distance driven by the users for the challenge |
totalNumberTrips |
| Total number of trips made by the users for the challenge |
users |
| List of users ranked in the challenge with enough data before the challenge (see UserNotRanked) |
UserRankedWithProgress
The table below summarizes the elements included in the UserRankedWithProgress
object.
Field | Type | Description |
---|---|---|
username |
| Unique identifier of the user |
firstname |
| First name of the user |
lastname |
| Last name of the user |
registerDate |
| Date at which the user entered the challenge
Date format: |
numberTrips |
| Number of trips since the user registered to the challenge |
distance |
| Distance since the user registered to the challenge |
rank |
| Current rank of the user |
score |
| Score of the user during the challenge |
scoreBefore |
| Score of the user during the pre-challenge period |
scoreEvolution |
| Evolution of the score of the user (i.e., effect of the challenge on the user's score) |
Last updated