Account

The account service provides a full list of drivers registered to your company.

For each driver, you will find useful information such as the registration date, the account details or the smartphone model.

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

Get drivers account information

get

Get the account information for selected drivers registered to your company. The results are paginated.

Query parameters

pageSizeinteger · min: 1000 · max: 20000Optional

Number of elements to return

Default: 1000

pageNumberintegerOptional

Position of the page to return, the first page has the position : 0

Default: 0

startDateintegerOptional

Minimum date of the user account data's last update (timestamp)

endDateintegerOptional

Maximum date of the user account data's last update (timestamp)

groupLabelstringOptional

Label of the group to retrieve

Default: all

statusstring · enumOptional

Status of the driver

Default: ALLAvailable options:

Header parameters

DriveKit-Admin-API-KeystringRequired

Drivekit Admin API key

Responses

application/json

objectOptionalExample: {"value":{"totalElements":3,"pageNumber":0,"pageSize":10,"hasNext":false,"data":[{"userId":"driver-1-id","firstname":"Driver-1-firstname","lastname":"Driver-1-lastname","pseudo":"Driver-1-pseudo","registerDate":"2020-12-27T16:26:28.000+0000","pushDataStatus":"UNKNOWN","groups":[],"clientData":{"license_plate":"11-AAA-11","acceptAdPush":"true"},"smartphoneData":{"phoneModel":"HUAWEI STF-L09","appBuildNumber":"415","appVersion":"4.2.25","osVersion":"28","osType":"Android","sdkVersion":"1.11.2","phoneLanguage":"FRENCH","rawPhoneLanguage":"fr-FR","lastUpdate":"2021-06-04T21:31:59.206+0000"}},{"userId":"driver-2-id","firstname":"Driver-2-firstname","lastname":"Driver-2-lastname","pseudo":"Driver-2-pseudo","registerDate":"2020-12-27T16:18:30.000+0000","pushDataStatus":"UNKNOWN","groups":[],"clientData":{"license_plate":"22-BBB-22","acceptAdPush":"false"},"smartphoneData":{"phoneModel":"HUAWEI DUB-LX1","appBuildNumber":"415","appVersion":"4.2.25","osVersion":"27","osType":"Android","sdkVersion":"1.11.2","phoneLanguage":"FRENCH","rawPhoneLanguage":"fr-FR","lastUpdate":"2021-05-31T12:20:08.239+0000"}},{"userId":"driver-3-id","firstname":"Driver-3-firstname","lastname":"Driver-3-lastname","pseudo":"Driver-3-pseudo","registerDate":"2020-12-27T19:03:21.000+0000","pushDataStatus":"UNKNOWN","groups":[],"clientData":{"license_plate":"33-CCC-33","acceptAdPush":"false"},"smartphoneData":{"phoneModel":"Xiaomi MI 8 Lite","appBuildNumber":"415","appVersion":"4.2.25","osVersion":"29","osType":"Android","sdkVersion":"1.11.2","phoneLanguage":"FRENCH","rawPhoneLanguage":"fr-FR","lastUpdate":"2021-06-05T13:30:29.834+0000"}}]}}

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /v3/drivekit/admin/drivers/account/page HTTP/1.1
Host: service.drivequant.com
DriveKit-Admin-API-Key: text
Accept: */*

{
  "value": {
    "totalElements": 3,
    "pageNumber": 0,
    "pageSize": 10,
    "hasNext": false,
    "data": [
      {
        "userId": "driver-1-id",
        "firstname": "Driver-1-firstname",
        "lastname": "Driver-1-lastname",
        "pseudo": "Driver-1-pseudo",
        "registerDate": "2020-12-27T16:26:28.000+0000",
        "pushDataStatus": "UNKNOWN",
        "groups": [],
        "clientData": {
          "license_plate": "11-AAA-11",
          "acceptAdPush": "true"
        },
        "smartphoneData": {
          "phoneModel": "HUAWEI STF-L09",
          "appBuildNumber": "415",
          "appVersion": "4.2.25",
          "osVersion": "28",
          "osType": "Android",
          "sdkVersion": "1.11.2",
          "phoneLanguage": "FRENCH",
          "rawPhoneLanguage": "fr-FR",
          "lastUpdate": "2021-06-04T21:31:59.206+0000"
        }
      },
      {
        "userId": "driver-2-id",
        "firstname": "Driver-2-firstname",
        "lastname": "Driver-2-lastname",
        "pseudo": "Driver-2-pseudo",
        "registerDate": "2020-12-27T16:18:30.000+0000",
        "pushDataStatus": "UNKNOWN",
        "groups": [],
        "clientData": {
          "license_plate": "22-BBB-22",
          "acceptAdPush": "false"
        },
        "smartphoneData": {
          "phoneModel": "HUAWEI DUB-LX1",
          "appBuildNumber": "415",
          "appVersion": "4.2.25",
          "osVersion": "27",
          "osType": "Android",
          "sdkVersion": "1.11.2",
          "phoneLanguage": "FRENCH",
          "rawPhoneLanguage": "fr-FR",
          "lastUpdate": "2021-05-31T12:20:08.239+0000"
        }
      },
      {
        "userId": "driver-3-id",
        "firstname": "Driver-3-firstname",
        "lastname": "Driver-3-lastname",
        "pseudo": "Driver-3-pseudo",
        "registerDate": "2020-12-27T19:03:21.000+0000",
        "pushDataStatus": "UNKNOWN",
        "groups": [],
        "clientData": {
          "license_plate": "33-CCC-33",
          "acceptAdPush": "false"
        },
        "smartphoneData": {
          "phoneModel": "Xiaomi MI 8 Lite",
          "appBuildNumber": "415",
          "appVersion": "4.2.25",
          "osVersion": "29",
          "osType": "Android",
          "sdkVersion": "1.11.2",
          "phoneLanguage": "FRENCH",
          "rawPhoneLanguage": "fr-FR",
          "lastUpdate": "2021-06-05T13:30:29.834+0000"
        }
      }
    ]
  }
}

Query parameters

Field	Type	Description
pageSize	int	Number of elements to return (default: 1000). Min: 1000 Max: 20000
pageNumber	int	Position of the page to return, the first page has the position : 0 (default: 0) Min: 0
startDate	int	Minimum date of the driver data's last update (timestamp)
endDate	int	Maximum date of the driver data's last update
groupLabel	string	Group name (default: All)
status	string	Status of the drivers (default: ALL). Possible values: ALL, NO_TRIP, EXPIRED, ACTIVE

The startDate and endDate parameters can be used to filter the drivers based on their most recent interaction with the application. This date reflects the driver's last activity and is updated according to several criteria: last trip recorded, account or smartphone information updates.

Response

The table below summarizes the list of elements included in the response.

Field	Type	Description
data	array[object]	List of requested driver's accounts (see below)
totalElements	int	Total number of accounts that can be retrieved
pageNumber	int	Position of the requested page (0 for the first page)
pageSize	int	Requested page size (between 1000 and 20000)
hasNext	boolean	Indicates whether there are more results to fetch

Data array

The data array contains a list of driver's account.

Field	Type	Description
userId	string	Driver's unique identifier set to initialize the DriveKit SDK
firstname	string	Driver's firstname
lastname	string	Driver's lastname
pseudo	string	Driver's pseudo
registerDate	string	Driver's registration date Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
pushDataStatus	string	Driver preference for data sharing Possible values: UNKNOWN, DENY or ACCEPT
groups	array[string]	List of groups to which the driver belongs
smartphoneData	SmartphoneData	Technical information on the driver's smartphone
clientData	ClientData	Client related metadata
admin	boolean	Indicates if the user is an administrator on the web dashboard
betaTester	boolean	Indicates if the account is a beta tester account

Smartphone data

The smartphoneData object includes details about the driver's smartphone.

Field	Type	Description
phoneModel	string	Smartphone manufacturer codename
appBuildNumber	string	Mobile app build number
appVersion	string	Version of the mobile app
osVersion	string	Version of the operating system
osType	string	Operating system
sdkVersion	string	DriveKit SDK version
phoneLanguage	string	Detected phone lanquage
rawPhoneLanguage	string	Raw phone language
lastUpdate	string	Date of last update Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ

Client data

Client data consists of customer-specific metadata such as: license plate number, commercial email opt-in, contract number (formatted as a map of key-value).

Error response

Unauthorized

If the request does not contain a valid authentication token, the service will answer with a http code 401.

Bad request

If the request cannot be processed, the service will answer with a http code 400. The response body will contain more details about the error:

Message Key	Message	Description
dk_invalid_parameter_value	Invalid value for parameter 'status'	The requested status does not exist
dk_invalid_parameter_value	Invalid value for parameter(s) '[...]'	The page size or the page number are not within the authorized range
invalid_group_label	Invalid group label	The requested group does not exist
invalid_start_date	Invalid start date	The start date is not valid, or is after the end date
invalid_end_date	Invalid end date	The end date is not valid