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

GEThttps://service.drivequant.com/v1/enterprise/push/trips/metrics

Query parameters

Header parameters

Response

200400401

OK

Body

application/json

statusenum

Current status of the push service

Example: "ACTIVE"

ACTIVEINACTIVEON_HOLD

startDatestring (date-time)

Start date of the report

Example: "2024-11-21T11:09:09.000+0000"

endDatestring (date-time)

End date of the report

Example: "2024-11-22T11:09:09.000+0000"

failedinteger

Number of failed push requests

Example: 3

pushedinteger

Number of successful push requests

Example: 3987

onHoldinteger

Number of push requests on-hold because the push service was paused automatically (too many failures)

Example: 0

totalinteger

Total number of push requests

Example: 3990

Request

JavaScriptCurlPython

const response = await fetch('https://service.drivequant.com/v1/enterprise/push/trips/metrics', {
    method: 'GET',
    headers: {
      "x-dq-enterprise-api-key": "text"
    },
});
const data = await response.json();

Response

200400

{
  "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