List of challenges
Last updated
Was this helpful?
Last updated
Was this helpful?
This service returns a list of all the challenges belonging to your organisation.
Each challenge has a unique identifier, which can be used as a parameter in all challenge services to access other challenge specific data. Of notice, archived challenges are excluded from this list.
If you have your admin API key, you can try the API via this link.
The service returns an array of ChallengeResponse.
The table below summarizes the elements included in the ChallengeResponse object.
challengeId
string
Unique identifier of the challenge
title
string
Title of the challenge
startDate
string
Starting date of the challenge
Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
endDate
string
Ending date of the challenge
Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
theme
string
Theme of the challenge
Possible values: SAFETY, ACCELERATION, BRAKING, PHONE_DISTRACTION, ECODRIVING, SPEEDING
type
string
Type of the challenge
Possible values: ALL_DRIVERS, SINGLE_GROUP, MULTIPLE_GROUPS
reportAvailabilityDate
string
Estimated date at which the results report of the challenge will be available
Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
admin
Creator of the challenge
status
string
Current status of the challenge
Possible values: DRAFT, PLANNED, IN_PROGRESS, FINISHED
registeredUsers
int
Total number of users registered to the challenge
rankedUsers
int
Total number of users ranked in the challenge
The challenges which were archived from the administration dashboard cannot be retrieved in this service. These challenges are also absent from the DriveKit SDK services.
The table below summarizes the elements included in the AdminInfo object.
username
string
Unique identifier of the user
firstname
string
First name of the user
lastname
string
Last name of the user