{ "opencollection": "1.0.0", "info": { "name": "Samsara Idling API", "version": "2024-11-18" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Idling", "type": "folder" }, "items": [ { "info": { "name": "Get Vehicle Idling Reports.", "type": "http" }, "http": { "method": "GET", "url": "https://api.samsara.com/fleet/reports/vehicle/idling", "params": [ { "name": "after", "value": "", "type": "query", "description": " 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." }, { "name": "limit", "value": "", "type": "query", "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects." }, { "name": "startTime", "value": "", "type": "query", "description": " 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)." }, { "name": "endTime", "value": "", "type": "query", "description": " 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)." }, { "name": "vehicleIds", "value": "", "type": "query", "description": " A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`" }, { "name": "tagIds", "value": "", "type": "query", "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`" }, { "name": "parentTagIds", "value": "", "type": "query", "description": " 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`" }, { "name": "isPtoActive", "value": "", "type": "query", "description": "A filter on the data based on power take-off being active or inactive." }, { "name": "minIdlingDurationMinutes", "value": "", "type": "query", "description": "A filter on the data based on a minimum idling duration." } ] }, "docs": "Get all vehicle idling reports for the requested time duration.\n\n Rate limit: 25 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read Fuel & Energy** under the Fuel & Energy category when creating or editing an API token. Learn More.\n \n\n **Submit Feedback**: Likes, dislikes, an" } ] } ], "bundled": true }