Get IFTA Summary

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,
      "month": "2021-01",
      "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

header

required

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.

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Query Parameters

cursor

string

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

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

Example:

"2021-01"

endMonth

string

required

Include vehicle reports up to and including this month

Example:

"2021-01"

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,

vehicle,jurisdiction,month

Response

200

application/json

results

object[]

required

results.provider

enum<string>

required

Available options:

azuga,

bigroad,

conti-go,

eld-mandate,

eld-mandate-plus,

eld-mandate-hos,

eld-rider,

eldone,

envue-telematics,

eroad,

eva-eld,

attrix,

advantage-one,

argos,

fleet-profit-center,

gps-tracking-canada,

graybox-solutions,

gridline,

high-point-gps,

io-tab,

blue-arrow,

eagle-wireless,

fleet-complete-hub,

fleetistics,

fort-knox,

fm-eld,

geotab,

gofleet,

gogps,

gps-insight,

gpstab,

isaac,

ksk,

switchboard,

linxup,

coretex-360,

apollo,

apollo-eld,

apollo-compass,

top-tracking-system,

eld-mandate-prime,

hos-reporter-plus,

hos247,

black-bear,

columbus-eld,

phoenix-eld,

route-eld,

reliable-eld,

trust-eld,

abc-eld,

tempus-eld,

vlog-eld,

just-eld,

factor-eld,

moonlight-eld,

daily-eld,

dfl-eld,

hero-eld,

infinity-eld,

ampm-eld,

forza-eld,

action-eld,

state-elog,

dy-eld,

cobra-eld,

flash-elogs,

renaissance-eld,

robinhood-eld,

sr-eld,

speedline-eld,

eld-2-go,

captain-eld,

ironman-eld,

powertrucks-eld,

paragon-eld,

youlog-eld,

legacy-eld,

master-eld,

monarch-tracking,

motive,

mountain-eld,

omnitracs-es,

omnitracs-xrs,

omnitracs,

one-step-gps,

optima-eld,

pro-ride-eld,

pti-eld,

real-eld,

right-trucking,

roadstar,

routemate,

samsara,

sandbox,

sparkle-eld,

tx-eld,

surfsight,

tfm-eld,

transflo,

truckx,

tt-eld,

verizon-fleet,

verizon-reveal,

verizon,

webfleet,

xeld,

xplore-eld,

zonar,

geotab-att,

zippy-eld,

evo-eld,

ontime-eld,

intelli-shift,

id-eld,

max-eld,

asrit-solutions,

smartelds,

eld-books,

vulcansols,

motion-eld,

blue-horse-eld,

apex-ultima,

radical-eld,

rock-eld,

lytx,

blue-ink,

utech,

light-and-travel-eld,

lion-eight,

pop-eld,

netradyne,

people-net

Example:

"geotab"

results.distance

number

required

Distance in kilometers

Example:

100

results.vehicle

Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.

Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

results.jurisdiction

enum<string> | null

US State or Canadian Province

Available options:

AL,

AK,

AS,

AZ,

AR,

CA,

CO,

CT,

DE,

FL,

GA,

GU,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MP,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

PR,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

VI,

AB,

BC,

MB,

NB,

NL,

NS,

ON,

PE,

QC,

SK,

NT,

NU,

UM,

YT,

DC

Example:

"TN"

results.month

string

ISO 8601 month

Example:

"2021-01"

results.raw

object[]

List of the raw data used to normalize the common model. Response schemas will vary by provider.

Raw data fetched from the source provider. Most of our endpoints support a raw query parameter that will append a list of the raw requests used to form our common model. This can be helpful for leveraging unique fields that are not part of our unified model.

Example:

[]

string

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

Latest Trailer Locations List All Connections

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,
      "month": "2021-01",
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

API Reference

Authentication

Vehicles

Drivers

Hours of Service

Trips

Devices

Safety

Groups

Trailers

IFTA

Connections

Data Management

Providers

Issues

Webhook Events

Authorizations

Headers

Query Parameters

Response