v1

latestOpenAPI 3.1.02026-07-22370342.6 KB

Safety

List Safety Events

List all safety events detected by the provider.

get/safety/events

Query parameters

cursorstring cursor

Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

limitinteger

The maximum number of results to return in a page.

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.

startedAfterstring date-time

ISO 8601 date

Example:2021-01-06T03:24:53.000Z

Only include records of statuses that started after a provided date.

startedBeforestring date-time

ISO 8601 date

Example:2021-01-06T03:24:53.000Z

Only include records of statuses that started 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.

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' | 'driver' | 'driver,vehicle' | 'vehicle,driver'

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

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "id": "sft_evt_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "sourceType": "HARD_CORE_BRAKING_MESSAGE",
      "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "startedAt": "2021-01-06T03:24:53.000Z",
      "startLocation": {
        "longitude": -122.4194155,
        "latitude": 37.7749295
      },
      "endedAt": "2021-01-06T03:24:53.000Z",
      "endLocation": {
        "longitude": -122.4194155,
        "latitude": 37.7749295
      },
      "stats": {
        "maximumSpeed": 95.33,
        "averageSpeed": 95.33,
        "roadSpeedLimit": 95.33,
        "gForceForwardBackward": 1,
        "gForceSideToSide": 1,
        "heading": 25
      },
      "cameraMedia": {
        "frontFacing": {
          "available": true,
          "sourceId": "12345"
        },
        "rearFacing": {
          "available": true,
          "sourceId": "12345"
        }
      },
      "extensions": {
        "here": {
          "speedLimit": 95.33,
          "speedLimitSource": "posted",
          "truckSpeedLimit": 95.33,
          "roadName": "John St"
        }
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}