Sign in

v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Hours of Service

List HOS Daily Logs

List daily summary of hours of service. Each daily log represents the time a driver spent in each duty status for a given day.

get/hos/daily-logs

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.

driverIdsstring

Comma separated list of driver IDs to filter for. Can filter up to 50 drivers at a time. Each ID must use the drv_ prefix.

rawboolean

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

expand'driver'

Expand resources in the returned response

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": [
    {
      "id": "hos_day_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "date": "2021-01-06",
      "distances": {
        "total": 100,
        "driving": 100,
        "personalConveyance": 100,
        "yardMove": 100
      },
      "statusDurations": {
        "onDuty": 11252299,
        "offDuty": 48478999,
        "driving": 26668701,
        "waiting": 232322,
        "sleeperBed": 2300000,
        "personalConveyance": 500000,
        "yardMove": 62000
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}