{ "opencollection": "1.0.0", "info": { "name": "Samsara Reports API", "version": "2024-11-18" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Get Fuel and Energy Efficiency Driver Reports.", "type": "http" }, "http": { "method": "GET", "url": "https://api.samsara.com/fleet/reports/drivers/fuel-energy", "params": [ { "name": "startDate", "value": "", "type": "query", "description": "A start date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time." }, { "name": "endDate", "value": "", "type": "query", "description": "An end date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time." }, { "name": "driverIds", "value": "", "type": "query", "description": " A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`" }, { "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": "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." } ] }, "docs": "Get fuel and energy efficiency driver reports for the requested time range.\n\n Rate limit: 5 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, d" }, { "info": { "name": "Get IFTA Jurisdiction Reports.", "type": "http" }, "http": { "method": "GET", "url": "https://api.samsara.com/fleet/reports/ifta/jurisdiction", "params": [ { "name": "year", "value": "", "type": "query", "description": " The year of the requested IFTA report summary. Must be provided with a month or quarter param. Example: `year=2021`" }, { "name": "month", "value": "", "type": "query", "description": " The month of the requested IFTA report summary. Can not be provided with the quarter param. Example: `month=January` Valid values: `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`" }, { "name": "quarter", "value": "", "type": "query", "description": " The quarter of the requested IFTA report summary. Can not be provided with the month param. Q1: January, February, March. Q2: April, May, June. Q3: July, August, September. Q4: October, November, December. Example: `quarter=Q1` Valid values: `Q1`, `Q2`, `Q3`, `Q4`" }, { "name": "jurisdictions", "value": "", "type": "query", "description": " A filter on the data based on this comma-separated list of jurisdictions. Example: `jurisdictions=GA`" }, { "name": "fuelType", "value": "", "type": "query", "description": " A filter on the data based on this comma-separated list of IFTA fuel types. Example: `fuelType=Diesel` Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`" }, { "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`" } ] }, "docs": "Get all jurisdiction IFTA reports for the requested time duration. Data is returned in your organization's defined timezone.\n\n**Note:** 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.\n\n Rate limit: 5 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read IFTA (US)*" }, { "info": { "name": "Get IFTA Vehicle Reports.", "type": "http" }, "http": { "method": "GET", "url": "https://api.samsara.com/fleet/reports/ifta/vehicle", "params": [ { "name": "year", "value": "", "type": "query", "description": " The year of the requested IFTA report summary. Must be provided with a month or quarter param. Example: `year=2021`" }, { "name": "month", "value": "", "type": "query", "description": " The month of the requested IFTA report summary. Can not be provided with the quarter param. Example: `month=January` Valid values: `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`" }, { "name": "quarter", "value": "", "type": "query", "description": " The quarter of the requested IFTA report summary. Can not be provided with the month param. Q1: January, February, March. Q2: April, May, June. Q3: July, August, September. Q4: October, November, December. Example: `quarter=Q1` Valid values: `Q1`, `Q2`, `Q3`, `Q4`" }, { "name": "jurisdictions", "value": "", "type": "query", "description": " A filter on the data based on this comma-separated list of jurisdictions. Example: `jurisdictions=GA`" }, { "name": "fuelType", "value": "", "type": "query", "description": " A filter on the data based on this comma-separated list of IFTA fuel types. Example: `fuelType=Diesel` Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`" }, { "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": "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." } ] }, "docs": "Get all vehicle IFTA reports for the requested time duration. Data is returned in your organization's defined timezone.\n\n**Note:** 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.\n\n Rate limit: 25 requests/sec (learn more about rate limits here).\n\nTo use this endpoint, select **Read IFTA (US)** un" }, { "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" }, { "info": { "name": "Get Fuel and Energy Efficiency Vehicle Reports.", "type": "http" }, "http": { "method": "GET", "url": "https://api.samsara.com/fleet/reports/vehicles/fuel-energy", "params": [ { "name": "startDate", "value": "", "type": "query", "description": "A start date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time." }, { "name": "endDate", "value": "", "type": "query", "description": "An end date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time." }, { "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": "energyType", "value": "", "type": "query", "description": "The type of energy used by the vehicle. Valid values: `fuel`, `hybrid`, `electric`" }, { "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": "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." } ] }, "docs": "Get fuel and energy efficiency vehicle reports for the requested time range.\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," } ] } ], "bundled": true }