SAsamsara
IFTA

Create a job to generate csv files of IFTA mileage segments.

Create a job to generate csv files of IFTA mileage segments.

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

To use this endpoint, select Write IFTA (US) under the Compliance 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.

post/ifta-detail/csv

Request

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

Request body

endHourstring required

An end time in RFC 3339 format. Hour precision and timezones are supported. Any minutes or seconds will be truncated down to the nearest hour. 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. The maximum request duration is 1 month. Limit the number of vehicles to 1000 when requesting more than 24 hours of data. (Examples: 2019-06-13T19:00:00Z, 2019-06-13T19:00:00.000Z, OR 2015-09-15T14:00:00-04:00).

startHourstring required

A start time in RFC 3339 format. Hour precision and timezones are supported. Any minutes or seconds will be truncated down to the nearest hour. 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. The maximum request duration is 1 month. Limit the number of vehicles to 1000 when requesting more than 24 hours of data. (Examples: 2019-06-13T19:00:00Z, 2019-06-13T19:00:00.000Z, OR 2015-09-15T14:00:00-04:00).

vehicleIdsstring

A filter on the data based on this comma-separated list of vehicle IDs and external IDs. The number of vehicles requested per job shouldn't exceed 5000. Example: vehicleIds: '1234,5678,samsara.vin:1HGBH41JXMN109186'

vehicleParentTagIdsstring

A filter on the data based on this comma-separated list of vehicle parent tag IDs. The number of vehicles requested per job shouldn't exceed 5000. Example: vehicleParentTagIds: '1234,5678'

vehicleTagIdsstring

A filter on the data based on this comma-separated list of vehicle tag IDs. The number of vehicles requested per job shouldn't exceed 5000. Example: vehicleTagIds: '1234,5678'

Example request

{
  "endHour": "2019-06-13T19:00:00Z",
  "startHour": "2019-06-13T19:00:00Z",
  "vehicleIds": "1234,5678,samsara.vin:1HGBH41JXMN109186",
  "vehicleParentTagIds": "1234,5678",
  "vehicleTagIds": "1234,5678"
}

Response

Created response.

Example response

{
  "data": {
    "args": {
      "endHour": "2019-06-13T19:00:00Z",
      "startHour": "2019-06-13T19:00:00Z",
      "vehicleIds": [
        12345678,
        56789123
      ]
    },
    "completedAtTime": "2019-06-13T19:00:00Z",
    "details": "Try limiting the number of vehicles requested per job to reduce the processing duration.",
    "failedAtTime": "2019-06-13T19:00:00Z",
    "files": [
      {
        "createdAtTime": "2019-06-13T19:00:00Z",
        "downloadUrl": "https://s3.download-url.com",
        "downloadUrlExpirationTime": "2019-06-13T19:00:00Z",
        "name": "output-001.csv.gz",
        "recordCount": 927776079462837100
      }
    ],
    "jobId": "8cabba84-bef4-4951-8cd2-78ce898fd8e6",
    "jobStatus": "Processing",
    "requestedAtTime": "2019-06-13T19:00:00Z",
    "startedAtTime": "2019-06-13T19:00:00Z"
  }
}

Changes

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