Challenge details

This service returns the details and rules of a challenge.

The most important characteristics of a challenge are the name, the theme and the conditions required to be ranked (minimum number of trips and distance).

If you have your admin API key, you can try the API via this link.

Retrieve a challenge

GEThttps://service.drivequant.com/v3/drivekit/admin/challenges/{challengeId}

Path parameters

challengeId*string

Unique identifier of the challenge

Header parameters

Response

200401404

OK

Body

application/json

challengeIdstring

Unique identifier of the challenge

titlestring

Title of the challenge

descriptionstring

Detailed description of the challenge

creationDatestring (date-time)

Creation date of the challenge

startDatestring (date-time)

Starting date of the challenge

endDatestring (date-time)

Ending date of the challenge

conditionsChallengeConditions

Conditions that need to be filled for a user to be ranked

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

groupsarray of string

List of groups participating in the challenge (empty if type is ALL_DRIVERS)

rulesstring

Rules of the challenge (in html format)

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

JavaScriptCurl

const response = await fetch('https://service.drivequant.com/v3/drivekit/admin/challenges/{challengeId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "challengeId": "text",
  "title": "text",
  "description": "text",
  "creationDate": "2024-04-30T14:12:24.523Z",
  "startDate": "2024-04-30T14:12:24.523Z",
  "endDate": "2024-04-30T14:12:24.523Z",
  "conditions": {},
  "theme": "SAFETY",
  "type": "ALL_DRIVERS",
  "reportAvailabilityDate": "2024-04-30T14:12:24.523Z",
  "groups": [
    "text"
  ],
  "rules": "text",
  "admin": {
    "username": "text",
    "firstname": "text",
    "lastname": "text"
  },
  "status": "DRAFT"
}

---

Response

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

Field	Type	Description
challengeId	string	Unique identifier of the challenge
title	string	Title of the challenge
description	string	Detailed description of the challenge
creationDate	string	Creation date of the challenge Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
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
conditions	ChallengeConditions	Conditions that need to be filled for a user to be ranked
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
groups	array[string]	List of groups participating in the challenge (empty if type is ALL_DRIVERS)
rules	string	Rules of the challenge (in html format)
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

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

ChallengeConditions

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

Field	Type	Description
km	int	Minimum distance required to be ranked (in km)
nbTrip	int	Minimum number of trips required to be ranked