WIwithterminal
Vehicle Utilization

Get Vehicle Utilization

Changed on

Get vehicle utilization days containing information about fuel consumption, distance traveled, and operational time metrics.

get/vehicles/utilization

Request

  • Base URL
    https://api.withterminal.com/tsp/v1
  • URL
    https://api.withterminal.com/tsp/v1/vehicles/utilization
  • Auth
    HTTP bearer

Query parameters

cursorstring cursor
Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

limitinteger

The maximum number of results to return in a page.

startDatestring date
Example:2021-01-06

Include records from on or after a specific date. Defaults to beginning of history

endDatestring date
Example:2021-01-06

Include records from on or before a specific date. Defaults to now

modifiedAfterstring date-time
Example:2021-01-06T03:24:53.000Z

Only include records that were last modified after a provided date.

modifiedBeforestring date-time
Example:2021-01-06T03:24:53.000Z

Only include records that were last modified before a provided date.

vehicleIdsstring

Comma separated list of vehicle IDs to filter for. Can filter up to 50 vehicles at a time. Each ID must use the vcl_ prefix.

expand'vehicle'

Expand resources in the returned response

rawboolean

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

Headers

X-Application-Idstring

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

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

Response

OK

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "provider": "geotab",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "fuelConsumed": 95.33,
      "distance": 100.25,
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Changes

  • 71081936e1bdRevision changes
    • breaking

      added the pattern ^[A-Za-z0-9+/=_-]+$ to the query request parameter cursor

    • breaking

      added to the // response property oneOf list for the response status

    • warning

      added the new provider_timeout enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      removed subschema #2: Expanded Vehicle from the // response property oneOf list for the response status

    • info

      the response's property pattern ^[A-Za-z0-9+/=_-]+$ was added for the status