List of challenges
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.
Response
The service returns an array of ChallengeResponse.
ChallengeResponse
The table below summarizes the elements included in the ChallengeResponse
object.
Field | Type | Description |
---|---|---|
challengeId |
| Unique identifier of the challenge |
title |
| Title of the challenge |
startDate |
| Starting date of the challenge
Date format: |
endDate |
| Ending date of the challenge
Date format: |
theme |
| Theme of the challenge
Possible values: |
type |
| Type of the challenge
Possible values: |
reportAvailabilityDate |
| Estimated date at which the results report of the challenge will be available
Date format: |
admin | Creator of the challenge | |
status |
| Current status of the challenge
Possible values: |
registeredUsers |
| Total number of users registered to the challenge |
rankedUsers |
| 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.
AdminInfo
The table below summarizes the elements included in the AdminInfo
object.
Field | Type | Description |
---|---|---|
username |
| Unique identifier of the user |
firstname |
| First name of the user |
lastname |
| Last name of the user |
Last updated