Activity timeline

The activity timeline service provides weekly and monthly chronological reports of the number of users in your organisation.

Weekly and monthly timelines include the following indicators:

• The total number of registered users which includes both the active and the inactive users.

• The number of new users who created an account during the given period.

• The number of active users: who recorded at least one trip during the given period.

• the number of deleted users during the given period.

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

Customer activity timeline

get

Get weekly and monthly chronological reports of the number of users in your organisation.

Header parameters

DriveKit-Admin-API-KeystringRequired

Drivekit Admin API key

Responses

200

OK

application/json

401

Unauthorized

get

HTTPcURLJavaScriptPython

GET /v3/drivekit/admin/customer/activity/timeline HTTP/1.1
Host: service.drivequant.com
DriveKit-Admin-API-Key: text
Accept: */*

{
  "week": {
    "date": [
      "2023-05-01T12:00:00.000+0000",
      "2023-05-08T12:00:00.000+0000",
      "2023-05-15T12:00:00.000+0000",
      "2023-05-22T12:00:00.000+0000",
      "2023-05-29T12:00:00.000+0000"
    ],
    "registeredUsers": [
      3,
      20,
      765,
      1209,
      1572
    ],
    "newUsers": [
      0,
      17,
      745,
      444,
      363
    ],
    "deletedUsers": [
      0,
      0,
      0,
      0,
      0
    ],
    "activeUsers": [
      0,
      10,
      381,
      705,
      956
    ]
  },
  "month": {
    "date": [
      "2023-05-01T12:00:00.000+0000"
    ],
    "registeredUsers": [
      971
    ],
    "newUsers": [
      968
    ],
    "deletedUsers": [
      0
    ],
    "activeUsers": [
      565
    ]
  }
}

Response

The table below summarizes the list of activity data.

Field	Type	Description
week	object	List of weekly activity (see CustomerActivityTimelineItem)
month	object	List of monthly activity (see CustomerActivityTimelineItem)

CustomerActivityTimelineItem

The monthly and weekly activity has the same structure, represented by a CustomerActivityTimelineItem object described in the table below.

Field	Type	Description
date	array[string]	Dates corresponding to the first day of the week or month. Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
registeredUsers	array[int]	Total number of registered users.
newUsers	array[int]	Number of new users in the given period.
deletedUsers	array[int]	Number of users having their accounts deleted in the given period.
activeUsers	array[int]	Number of active users who recorded at least one trip during the given period.