Skip to main content
GET
Get Drives

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vin
string
required

The associated VIN.

Query Parameters

distance_format
enum<string>
default:mi

Whether to return data in miles or kilometers.

Available options:
mi,
km
temperature_format
enum<string>
default:c

Whether to return data in Fahrenheit or Celsius.

Available options:
c,
f
from
number

The start of the timeframe. Unix timestamp in seconds.

to
number

The end of the timeframe. Unix timestamp in seconds.

timezone
string
default:UTC

The IANA timezone name.

origin_latitude
number

The latitude of the starting point.

Example:

37.4925

origin_longitude
number

The longitude of the starting point.

Example:

121.9447

origin_radius
number

The radius from the starting point, in meters.

Example:

80

exclude_origin
boolean
default:false

Whether to exclude the starting point.

destination_latitude
number

The latitude of the ending point.

Example:

37.4925

destination_longitude
number

The longitude of the ending point.

Example:

121.9447

destination_radius
number

The included radius from the ending point, in meters.

Example:

80

exclude_destination
boolean
default:false

Whether to exclude the ending point.

tag
string

The tag associated with the drive.

Example:

"Work"

exclude_tag
boolean
default:false

Whether to exclude the tag.

driver_profile
string

The driver profile associated with the drive.

Example:

"John"

exclude_driver_profile
boolean
default:false

Whether to exclude the driver profile.

format
enum<string>
default:json

Whether to output the results in JSON or CSV.

Available options:
json,
csv
minimum_distance
number

The minimum distance driven, in miles.

Example:

0.1

limit
number

The maximum number of results.

Response

200 - application/json

Success

results
Drive · object[]