REST API
SUPPORTFEEDBACK

[legacy] Get vehicle idling reports.

get
https://api.samsara.com/fleet/reports/vehicle/idling

Note: This is a legacy endpoint, consider using this endpoint instead. The endpoint will continue to function as documented. Get all vehicle idling reports for the requested time duration.

Rate limit: 25 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Fuel & Energy under the Fuel & Energy category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Query Params
string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

integer
1 to 512
Defaults to 512

The limit for how many objects will be in the response. Default and max for this value is 512 objects.

string
required

A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

string
required

An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

string

A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186

string

A filter on the data based on this comma-separated list of tag IDs. Example: tagIds=1234,5678

string

A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: parentTagIds=345,678

boolean

A filter on the data based on power take-off being active or inactive.

integer
≥ 1

A filter on the data based on a minimum idling duration.

Responses

Updated 6 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago