SAsamsara
Legacy APIs

[legacy] Get vehicle idling reports.

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.

<b>Rate limit:</b> 25 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Fuel & Energy under the Fuel & Energy category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/fleet/reports/vehicle/idling

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

afterstring

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.

limitinteger

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

startTimestring 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).

endTimestring 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).

vehicleIdsstring

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

tagIdsstring

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

parentTagIdsstring

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

isPtoActiveboolean

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

minIdlingDurationMinutesinteger

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

Response

OK response.

requestEndTimestring required

The requested end time in RFC 3339 format.

requestStartTimestring required

The requested start time in RFC 3339 format.

Example response

{
  "data": [
    {
      "address": {
        "formatted": "123 Main Street Atlanta, GA 30307",
        "latitude": 34.654567,
        "longitude": 34.654567
      },
      "durationMs": 860000,
      "endTime": "2019-06-13T19:08:25Z",
      "fuelConsumptionMl": 2500,
      "startTime": "2019-06-13T19:08:25Z",
      "vehicle": {
        "id": "494123",
        "name": "Fleet Truck #1"
      }
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  },
  "requestEndTime": "2019-06-13T19:08:25Z",
  "requestStartTime": "2019-06-13T19:08:25Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.