GET
/
ifta
/
summary
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/ifta/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    {
      "provider": "geotab",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "jurisdiction": "TN",
      "distance": 100,
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Currently can only increment by full months.

Note: data may change for a few days after the month. We will continue to update those reports to ensure you get accurate results.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Connection-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Query Parameters

cursor
string

Pagination cursor to start requests from

expand
enum<string>

Expand resources in the returned response

Available options:
vehicle
raw
boolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

startMonth
string
required

The month from which to start including vehicle reports

endMonth
string
required

Include vehicle reports up to and including this month

groupBy
enum<string>
default: vehicle,jurisdiction

Computes the total distance traversed within a specified month range, with the results grouped by either jurisdiction, vehicle, or both. If no grouping parameter is provided, the default grouping is vehicle,jurisdiction.

Available options:
jurisdiction,
vehicle,
vehicle,jurisdiction

Response

200 - application/json
results
object[]
required
next
string

Cursor used for pagination.