Challenge ranking

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:

Retry-After: Wed, 21 Oct 2022 07:28:00 GMT

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.

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 ChallengeRankingsResponse object.

ChallengeConditions

The table below summarizes the elements included in the ChallengeConditions object.

UserNotRanked

The table below summarizes the elements included in the UserNotRanked object.

UserRanked

The table below summarizes the elements included in the UserRanked object.

Last updated