Get a push trip data report

This service provides the number of successful and failed push requests over the last 24 hours, for all the teams belonging to your organisation.

These statistics only account for trips that have been recorded by the DriveKit SDK, sent to the DriveQuant analysis platform and processed.

By default, the report covers the last 24 hours. However, you can specify a startDate to generate the report for a more precise timeframe. If the startDate is more than 24h ago, it will be disregarded. For simplicity, the response includes both the endDate (date of the request) and the startDate (up to 24h before the startDate).

The date corresponds to the date the trip data are processed on the DriveQuant analysis platform.

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

Get the push trip metrics

get

Query parameters

startDatestring · date-timeOptional

Start date of the report (ignored if older than 24h from now)

Example: 2024-11-15T11:00:00.000Z

Header parameters

x-dq-enterprise-api-keystringRequired

Enterprise API key

Responses

200

OK

application/json

400

Bad request

application/json

401

Unauthorized

get

/push/trips/metrics

HTTPcURLJavaScriptPython

GET /v1/enterprise/push/trips/metrics HTTP/1.1
Host: service.drivequant.com
x-dq-enterprise-api-key: text
Accept: */*

{
  "status": "ACTIVE",
  "startDate": "2024-11-21T11:09:09.000+0000",
  "endDate": "2024-11-22T11:09:09.000+0000",
  "failed": 3,
  "pushed": 3987,
  "onHold": 0,
  "total": 3990
}

Response

The table below summarizes the response parameters.

Name	Type	Description
status	string	Current status of the push service Allowed values: ACTIVE, ON_HOLD, INACTIVE
startDate	string	Start date of the report Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
endDate	string	End date of the report (i.e., date of the request) Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
failed	integer	Number of failed push requests
pushed	integer	Number of successful push requests
onHold	integer	Number of push requests on-hold (if the push service was paused)
total	integer	Total number of push requests