Fleet Trips Points

This call provides Fleet Trips Points data for vehicles in an asynchronous mode. It creates a report which you can follow on Get Report Status. The report includes any trip points that have a start time and end time within the configured period.

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

🚧

Filters Usage Clarification

There are 2 options to use filters as body parameters to operate the Trips Points report:

  • Using the mandatory fields: start & end datetime + country_codes / vins to get all trips and points.
  • Using the trip_ids field to get all points associated with the given trip.

📘

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.

string

Specify the trip_id that you wish to extract its points into a separated report.

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