Safety Event - Terminal

{
  "id": "sft_evt_01D8ZQFGHVJ858NBF2Q7DV9MNC",
  "sourceId": "123456789",
  "provider": "geotab",
  "type": "harsh_brake",
  "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
  "startedAt": "2021-01-06T03:24:53.000Z",
  "metadata": {
    "addedAt": "2023-11-07T05:31:56Z",
    "modifiedAt": "2023-11-07T05:31:56Z"
  },
  "sourceType": "HARD_CORE_BRAKING_MESSAGE",
  "driver": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC",
  "endedAt": "2021-01-06T03:24:53.000Z",
  "stats": {
    "maximumSpeed": 95.33,
    "averageSpeed": 95.33,
    "roadSpeedLimit": 95.33,
    "gForceForwardBackward": 1,
    "gForceSideToSide": 1,
    "heading": 25
  },
  "cameraMedia": {},
  "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": []
}

Field Coverage

The percentage of connections across all providers that have data populated for each field.

Field	Coverage
`cameraMedia.frontFacing.available`	16.8%
`cameraMedia.frontFacing.sourceId`	8.5%
`cameraMedia.rearFacing.available`	11%
`cameraMedia.rearFacing.sourceId`	8.4%
`driver`	63%
`endedAt`	79.4%
`endLocation.latitude`	70.1%
`endLocation.longitude`	70.1%
`id`	100%
`provider`	100%
`sourceId`	100%
`startedAt`	100%
`startLocation.latitude`	94.3%
`startLocation.longitude`	94.3%
`stats.averageSpeed`	72.8%
`stats.gForceForwardBackward`	11.8%
`stats.gForceSideToSide`	5.9%
`stats.heading`	27.3%
`stats.maximumSpeed`	81.6%
`stats.roadSpeedLimit`	41.5%
`type`	100%
`vehicle`	100%

string<ulid>

required

Pattern: ^sft_evt_[0-9A-HJKMNP-TV-Z]{26}$

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,

unsafe_parking

vehicle

required

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

Pattern: ^vcl_[0-9A-HJKMNP-TV-Z]{26}$

Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

startedAt

string<date-time>

required

ISO 8601 date

Example:

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

metadata

EntityMetadata · object

required

Internal metadata about the record.

Show child attributes

sourceType

string

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

Example:

"HARD_CORE_BRAKING_MESSAGE"

driver

Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.

Pattern: ^drv_[0-9A-HJKMNP-TV-Z]{26}$

Example:

"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"

startLocation

Coordinates · object

Show child attributes

endedAt

string<date-time>

ISO 8601 date

Example:

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

endLocation

Coordinates · object

Show child attributes

stats

object

Show child attributes

cameraMedia

Camera Media Reference · object

Show child attributes

extensions

object

Includes data enriched via third-party vendors. See Extensions

Show child attributes

raw

RawData · object[]

Show child attributes

Example:

[]

Vehicle Stat Log Trip

⌘I

Common Models

Documentation Index

​Field Coverage

Field Coverage