Retrieve driving history

Retrieve the driving history of a specific device, driver from a specific time range.

Request
Security:
bearerAuth
query Parameters
driverThirdPartyId
string (driverThirdPartyId)

Filter by the driver's third party ID. Obtain this ID from GET /drivers.

Example: driverThirdPartyId=moshe123
organizationId
string (Organization ID as string) ^[1-9]\d*$

Filter by the ID of the organization. Obtain this from GET /organizations. (When using partner token, Organization ID is required.)

Example: organizationId=17
imei
string

Filter by the IMEI number of the device. The IMEI number can be found on a sticker on the device or on the back of the device box.

Example: imei=12345678
start
string <date-time> (Start date and time)

Filter by a start date and time, in ISO 8601 format.

Example: start=2020-01-01T14:48:00.000Z
end
string <date-time> (End date and time)

Filter by an end date and time, in ISO 8601 format.

Example: end=2020-01-01T14:48:00.000Z
sort
string (Sort)
Default: "createdAt"

Sort the driving history results.

Value: "createdAt"
order
string (Order)
Default: "desc"

Set the order that pagination results appear in - ascending or descending order.

Enum: "asc" "desc"
offset
string^[1-9]\d*$
Default: "0"

Set the number of results to skip over before receiving pagination results.

Example: offset=1
limit
string^[1-9]\d*$
Default: "0"

Set the maximum number of pagination results to receive.

Example: limit=1
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/driving-history
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/driving-history?driverThirdPartyId=moshe123&organizationId=17&imei=12345678&start=2020-01-01T14%3A48%3A00.000Z&end=2020-01-01T14%3A48%3A00.000Z&sort=createdAt&order=asc&offset=1&limit=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
    1 more
    500
application/json
{
  • "data": [
    ]
}