GET
/
safety
/
events
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/safety/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    {
      "id": "sft_evt_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "sourceId": "123456789",
      "provider": "geotab",
      "type": "harsh_brake",
      "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",
          "linkAttributes": {
            "countryCode": "<string>",
            "vehicleTypes": "<string>",
            "isUrban": "<string>",
            "transportVerified": "<string>",
            "functionalClass": "<string>",
            "controlledAccess": "<string>",
            "limitedAccessRoad": "<string>",
            "travelDirection": "<string>",
            "isBoatFerry": "<string>",
            "isRailFerry": "<string>",
            "isMultiDigitized": "<string>",
            "isDivided": "<string>",
            "isDividerLegal": "<string>",
            "isFrontage": "<string>",
            "isPaved": "<string>",
            "isRamp": "<string>",
            "isPrivate": "<string>",
            "hasPoiAccess": "<string>",
            "intersectionCategory": "<string>",
            "speedCategory": "<string>",
            "laneCategory": "<string>",
            "coverageIndicator": "<string>",
            "lowMobility": "<string>",
            "hasPublicAccess": "<string>",
            "routeTypes": "<string>"
          },
          "weather": {
            "latitude": 123,
            "longitude": 123,
            "temperature": 123,
            "dewPoint": 123,
            "humidity": 123,
            "pressure": 123,
            "windSpeed": 123,
            "windDirection": 123,
            "locationId": "<string>",
            "precipitationType": "<string>",
            "intensityOfPrecipitation": 123,
            "visibility": 123
          }
        }
      },
      "metadata": {
        "addedAt": "2023-11-07T05:31:56Z",
        "modifiedAt": "2023-11-07T05:31:56Z"
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

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"

​
limit
integer

The maximum number of results to return in a page.

​
modifiedAfter
string

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

Example:

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

​
modifiedBefore
string

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

Example:

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

​
startedAfter
string

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

Example:

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

​
startedBefore
string

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

Example:

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

​
driverIds
string

Comma separated list of driver IDs to filter for. Can filter up to 50 drivers at a time.

​
vehicleIds
string

Comma separated list of vehicle IDs to filter for. Can filter up to 50 vehicles at a time.

​
expand
enum<string>

Expand resources in the returned response

Available options:
vehicle,
driver,
driver,vehicle,
vehicle,driver
​
raw
boolean

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

Response

200
application/json
OK
​
results
object[]
required
​
next
string

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"