LogoLogo
ProductsUse casesDocsSupport
  • Introducing DriveKit
  • DriveKit Guides
  • Get started with drivekit
    • Trip recording lifecycle
    • iOS
      • 🚀Quick start
      • Advanced configurations
      • References
      • iOS DriveKit Demo App
    • Android
      • 🚀Quick start
      • Advanced configurations
      • References
      • Android DriveKit Demo App
      • Android 15 Migration guide
      • Android 14 Migration guide
      • Troubleshooting
  • Trip analysis
    • Introduction
    • iOS
      • Permissions
      • Trip management
      • TripListener
      • Crash Detection
      • Beacon usage
      • Bluetooth usage
      • Custom metadata
      • References (iOS)
    • Android
      • Runtime permissions
      • Trip management
      • TripListener
      • Crash Detection
      • Beacon usage
      • Bluetooth usage
      • Custom metadata
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Working hours
        • Driver alert in case of crash
        • Trip recording widget
        • Location sharing
      • Android
        • Get started
        • Working hours
        • Driver alert in case of crash
        • Trip recording widget
        • Location sharing
    • REST services
      • Trip
      • References
    • Trip Simulator
      • iOS
      • Android
  • PERMISSIONS UTILS
    • Introduction
    • User interface
      • iOS
        • Get started
        • Main configurations
      • Android
        • Get started
        • Main configurations
  • COMMON UI
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
    • References
  • DRIVER DATA
    • Introduction
    • iOS
      • Get started
      • References (iOS)
    • Android
      • Get started
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Advanced configurations
        • Trips widgets
        • My Synthesis
        • My Driver Profile
      • Android
        • Get Started
        • Advanced configurations
        • Trips widgets
        • My Synthesis
        • My Driver Profile
  • Driver Data Timeline UI
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
  • Vehicle
    • Introduction
    • iOS
      • Get started
      • Vehicle management
      • Beacon management
      • Bluetooth device management
      • Odometer
      • References (iOS)
    • Android
      • Get started
      • Vehicle management
      • Beacon management
      • Bluetooth device management
      • Odometer
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Main configurations
        • Advanced configurations
      • Android
        • Get started
        • Main configurations
        • Advanced configurations
  • DRIVER ACHIEVEMENT
    • Introduction
    • iOS
      • Get started
    • Android
      • Get Started
    • User interface
      • iOS
      • Android
  • CHALLENGE
    • Introduction
    • Important challenge rules
    • iOS
      • Get started
      • References (iOS)
    • Android
      • Get started
      • References (Android)
    • User interface
      • iOS
        • Get started
      • Android
        • Get started
  • GROUP
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
  • React Native
    • Get started
    • Integration
  • Flutter
    • Get started
    • Integration
  • Push services
    • Introduction
    • Push Trip Data
    • Push Deleted trip
    • Push Crash Data
    • Push Diagnosis Data
  • ADMIN SERVICES
    • Beacon
      • Add
      • Replace
      • Delete
      • Configuration
    • Challenges
      • List of challenges
      • Challenge details
      • Registered users
      • Challenge ranking
      • Users' progress
      • Definitions
    • Customer
      • Activity timeline
    • Driver
      • Timeline
      • Synthesis
      • Identity
      • Status
      • Add or update a metadata
      • Vehicles
      • Profile
      • Application diagnoses
    • Drivers
      • Account
      • Statistics
      • Ranking
      • Expired accounts
    • Group
      • Timeline
      • Synthesis
    • Trips
      • Add or update a metadata
      • Delete a metadata
    • Vehicle
      • Create
      • Characteristics
      • Configuration
      • Statistics
      • Update mileage
      • Tire and brake wear update
      • References
  • Crashes
    • Annotate a crash
    • Revoke crash location URL
  • ENTERPRISE SERVICES
    • Introduction
    • Teams
      • Create a team
      • List of teams
      • Enable or disable a team
    • Hyper-admins
      • Create a hyper-admin
      • List of hyper-admins
      • Delete a hyper-admin
    • Monitoring
      • Get a push trip data report
      • Get a push crash data report
      • Request to retry failed trips
      • Request to retry failed crashes
      • Get the status of a task
  • Release notes
    • Changelog
      • iOS
      • Android
      • UI iOS
      • UI Android
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. ADMIN SERVICES
  2. Challenges

Challenge details

PreviousList of challengesNextRegistered users

Last updated 1 year ago

Was this helpful?

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 .


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

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

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

ChallengeConditions
AdminInfo
link

Retrieve a challenge

get
Authorizations
Path parameters
challengeIdstringRequired

Unique identifier of the challenge

Header parameters
DriveKit-Admin-API-KeystringRequired

Drivekit Admin API key

Responses
200
OK
application/json
401
Unauthorized
application/json
404
Not Found
application/json
get
GET /v3/drivekit/admin/challenges/{challengeId} HTTP/1.1
Host: service.drivequant.com
DriveKit-Admin-API-Key: text
Accept: */*
{
  "challengeId": "text",
  "title": "text",
  "description": "text",
  "creationDate": "2025-05-09T05:30:59.032Z",
  "startDate": "2025-05-09T05:30:59.032Z",
  "endDate": "2025-05-09T05:30:59.032Z",
  "conditions": {
    "km": 1,
    "nbTrip": 1
  },
  "theme": "SAFETY",
  "type": "ALL_DRIVERS",
  "reportAvailabilityDate": "2025-05-09T05:30:59.032Z",
  "groups": [
    "text"
  ],
  "rules": "text",
  "admin": {
    "username": "text",
    "firstname": "text",
    "lastname": "text"
  },
  "status": "DRAFT",
  "registeredUsers": 1,
  "rankedUsers": 1
}
  • GETRetrieve a challenge
  • Response
  • AdminInfo
  • ChallengeConditions