Fleet Trips Data

This call provides Fleet Trips data for vehicles in an asynchronous mode. It creates a report which you can follow on Get Report Status. This is a premium feature - to unlock please contact [email protected] report includes any trip that has a start time and end time within the configured period.The report includes any trip that has started at, ended at or passed through the selected geography (Country, State, City, or Polygon).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

Trips Geo Route usage in Personal

When using one of the geographic filters (Country, State, City, Polygon), the "metadata_reason_for_selection_geographic_filter" attribute is added automatically to the generated report.
Otherwise, this attribute is eliminated within the generated report.

📘

Read about API Rate Limits

📘

Read more about Error Codes.

Body Params
vins
array of strings

Array of vins, quoted and comma delimited.

vins
string
required

The start date and time of the report (YYYY-MM-DD HH:MM:SS). This is a mandatory field.

string
required

The end date and time of the report (YYYY-MM-DD HH:MM:SS). This is a mandatory field.

country_codes
array of strings

Comma separated strings of 2-or-3 lettered country codes.

country_codes
states
array of strings

Comma separated strings of state names. The country_codes filter is required when using this parameter.

states
cities
array of strings

Comma separated strings of city names. The country_codes filter is required when using this parameter.

cities
polygon
array of strings

We support 2 formats: 1. WKT Format 2. A list of lists comprised of dictionaries representing each point (lon, lat) in a polygon. The country_codes filter is required when using this parameter.

polygon
int32

The maximum number of cars the report should return.

int32

The maximum number of data points allowed per report. This is a mandatory field.

boolean
Defaults to true

When set as 'true, the generated report will include Trips that have started at the selected geography (Country, State, City, Polygon)

boolean
Defaults to true

When set as 'true, the generated report will include Trips that have passed through the selected geography (Country, State, City, Polygon)

boolean
Defaults to true

When set as 'true, the generated report will include Trips that have ended at the selected geography (Country, State, City, Polygon)

Headers
string
required
Defaults to Bearer bNiIsInR5cCXr_si0C

Workspace access token preceded by the token type string for OAuth2, "Bearer".

string

application/json

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json