Safety Event - Terminal

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"

metadata

object

required

Internal metadata about the record.

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

extensions.here

object

Data obtained from the HERE platform.

extensions.here.speedLimit

number

Speed limit of the road in KPH obtained from the HERE platform.

Example:

95.33

extensions.here.speedLimitSource

enum<string>

Source for speed limit obtained from the HERE platform.

Available options:

posted,

derived

Example:

"posted"

extensions.here.truckSpeedLimit

number

Speed limit for Trucks in KPH obtained from the HERE platform.

Example:

95.33

extensions.here.roadName

string

Name of the road obtained from the HERE platform.

Example:

"John St"

extensions.here.linkAttributes

object

Additional road attributes from HERE platform

extensions.here.linkAttributes.countryCode

string

ISO country code of the road location

extensions.here.linkAttributes.vehicleTypes

string

Types of vehicles allowed

extensions.here.linkAttributes.isUrban

string

Indicates if the road is in an urban area

extensions.here.linkAttributes.transportVerified

string

Indicates if transport information is verified

extensions.here.linkAttributes.functionalClass

string

Road functional class according to HERE Maps:

0: Unknown
1: Functional Class 1
2: Functional Class 2
3: Functional Class 3
4: Functional Class 4
5: Functional Class 5

extensions.here.linkAttributes.controlledAccess

string

Indicates if the road has controlled access

extensions.here.linkAttributes.limitedAccessRoad

string

Indicates if it's a limited access road

extensions.here.linkAttributes.travelDirection

string

Direction of travel

extensions.here.linkAttributes.isBoatFerry

string

Indicates if it's a boat ferry route

extensions.here.linkAttributes.isRailFerry

string

Indicates if it's a rail ferry route

extensions.here.linkAttributes.isMultiDigitized

string

Indicates if the road is multi-digitized

extensions.here.linkAttributes.isDivided

string

Indicates if the road is divided

extensions.here.linkAttributes.isDividerLegal

string

Indicates if the divider is legal

extensions.here.linkAttributes.isFrontage

string

Indicates if it's a frontage road

extensions.here.linkAttributes.isPaved

string

Indicates if the road is paved

extensions.here.linkAttributes.isRamp

string

Indicates if it's a ramp

extensions.here.linkAttributes.isPrivate

string

Indicates if it's a private road

extensions.here.linkAttributes.hasPoiAccess

string

Indicates if there's POI access

extensions.here.linkAttributes.intersectionCategory

string

Type of intersection according to HERE Maps:

0: Unknown
1: Intersection Internal
2: Manoeuvre
3: Indescribable
4: Roundabout
5: Undefined Traffic Area
6: Special Traffic Figure

extensions.here.linkAttributes.speedCategory

string

Speed category according to HERE Maps:

0: Unknown
1: Over 130 km/h (80 mph)
2: 101-130 km/h (65-80 mph)
3: 91-100 km/h (55-64 mph)
4: 71-90 km/h (41-54 mph)
5: 51-70 km/h (31-40 mph)
6: 31-50 km/h (21-30 mph)
7: 11-30 km/h (6-20 mph)
8: Under 11 km/h (6 mph)

extensions.here.linkAttributes.laneCategory

string

Lane category according to HERE Maps:

0: Unknown
1: One lane
2: Two or three lanes
3: Four or more lanes

extensions.here.linkAttributes.coverageIndicator

string

Coverage indicator

extensions.here.linkAttributes.lowMobility

string

Low mobility indicator:

0: Unknown (Default)
1: Low mobility driving condition
2: Not low mobility driving condition

extensions.here.linkAttributes.hasPublicAccess

string

Indicates if there's public access

extensions.here.linkAttributes.routeTypes

string

Types of routes

extensions.here.weather

object

Weather conditions at the time of the event

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:

[]

Trip IFTA Summary

{
  "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": []
}

Common Models