Skip to main content
GET
Get Safety Event

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Application-Id
string

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-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Pattern: ^con_tkn_\S+$
Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Path Parameters

id
string<ulid>
required

The id of the safety event.

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

"sft_evt_01D8ZQFGHVJ858NBF2Q7DV9MNC"

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

OK

id
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
Example:

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

metadata
EntityMetadata · 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

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
endedAt
string<date-time>
Example:

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

endLocation
Coordinates · object
stats
object
cameraMedia
Camera Media Reference · object
extensions
object

Includes data enriched via third-party vendors. See Extensions

raw
RawData · object[]
Example: