GET
/
safety
/
events
/
{id}
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/safety/events/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "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
      }
    }
  },
  "raw": []
}

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"

Path Parameters

​
id
string
required

The id of the safety event.

Query Parameters

​
expand
enum<string>

Expand resources in the returned response

Available options:
driver,
vehicle,
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
​
id
string
required
Example:

"sft_evt_01D8ZQFGHVJ858NBF2Q7DV9MNC"

​
sourceId
string
required

The ID used to represent the entity in the source system.

Example:

"123456789"

​
provider
string
required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

Example:

"geotab"

​
type
enum<string>
required
Available options:
harsh_brake,
harsh_acceleration,
harsh_turn,
speeding,
crash,
near_crash,
tailgating,
cell_phone,
distracted,
drowsiness,
smoking,
seat_belt_violation,
stop_sign_violation,
red_light_violation,
unsafe_lane_change,
camera_obstruction,
eating_and_drinking,
rolling_stop
​
vehicle
required

The ID of the vehicle that was involved in the event.

Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

​
startedAt
string
required

ISO 8601 date

Example:

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

​
sourceType
string

The original event type as defined by the telematics provider's system

Example:

"HARD_CORE_BRAKING_MESSAGE"

​
driver

The ID of the driver that was driving during the event.

Example:

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

​
startLocation
object
​
endedAt
string

ISO 8601 date

Example:

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

​
endLocation
object
​
stats
object
​
cameraMedia
object
​
extensions
object

Includes data enriched via third-party vendors. See Extensions

​
raw
object[]

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:
[]