WIwithterminal
Safety

Get Safety Event

Changed on

Get a safety event by id.

get/safety/events/{id}

Request

  • Base URL
    https://api.withterminal.com/tsp/v1
  • URL
    https://api.withterminal.com/tsp/v1/safety/events/{id}
  • Auth
    HTTP bearer

Query parameters

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

OK

idstring ulid required
sourceIdstring required

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

providerstring required

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

type'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' required
sourceTypestring

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

startedAtstring date-time required

ISO 8601 date

endedAtstring date-time

ISO 8601 date

Example response

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

Changes

  • 71081936e1bdRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed subschema #2: Expanded Driver from the response property oneOf list for the response status

    • info

      removed subschema #2: Expanded Vehicle from the response property oneOf list for the response status