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.

List all challenges

GEThttps://service.drivequant.com/v3/drivekit/admin/challenges

Header parameters

Response

200401

OK

Body

application/json

challengeIdstring

Unique identifier of the challenge

titlestring

Title of the challenge

startDatestring (date-time)

Starting date of the challenge

Pattern: YYYY-MM-dd'T'HH:mm:ss.SSSZ

endDatestring (date-time)

Ending date of the challenge

Pattern: YYYY-MM-dd'T'HH:mm:ss.SSSZ

themeenum

Theme of the challenge

SAFETYACCELERATIONBRAKINGPHONE_DISTRACTIONECODRIVINGSPEEDING

typeenum

Type of the challenge

ALL_DRIVERSSINGLE_GROUPMULTIPLE_GROUPS

reportAvailabilityDatestring (date-time)

Estimated date at which the results report of the challenge will be available

Pattern: YYYY-MM-dd'T'HH:mm:ss.SSSZ

adminall of

Creator of the challenge

statusenum

Current status of the challenge

DRAFTPLANNEDIN_PROGRESSFINISHED

registeredUsersinteger

Total number of users registered to the challenge

rankedUsersinteger

Total number of users ranked in the challenge

Request

JavaScriptCurlPython

const response = await fetch('https://service.drivequant.com/v3/drivekit/admin/challenges', {
    method: 'GET',
    headers: {
      "DriveKit-Admin-API-Key": "text"
    },
});
const data = await response.json();

Response

200401

[
  {
    "challengeId": "text",
    "title": "text",
    "startDate": "2024-11-21T06:29:00.054Z",
    "endDate": "2024-11-21T06:29:00.054Z",
    "theme": "SAFETY",
    "type": "ALL_DRIVERS",
    "reportAvailabilityDate": "2024-11-21T06:29:00.054Z",
    "admin": {
      "username": "text",
      "firstname": "text",
      "lastname": "text"
    },
    "status": "DRAFT"
  }
]

---

Response

The service returns an array of ChallengeResponse.

ChallengeResponse

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

Field	Type	Description
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	AdminInfo	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.

AdminInfo

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

Field	Type	Description
username	string	Unique identifier of the user
firstname	string	First name of the user
lastname	string	Last name of the user