List Safety Events

GET

safety

events

curl --request GET \
  --url https://api.withterminal.com/tsp/v1/safety/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'

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

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.

Query Parameters

cursor

string

Pagination cursor to start requests from

limit

integer

The maximum number of results to return in a page.

modifiedAfter

string

Only include records that were last modified after a provided date.

modifiedBefore

string

Only include records that were last modified before a provided date.

startedAfter

string

Only include records of statuses that started after a provided date.

startedBefore

string

Only include records of statuses that started before a provided date.

driverIds

string

Comma separated list of driver IDs to filter for. Can filter up to 50 drivers at a time.

vehicleIds

string

Comma separated list of vehicle IDs to filter for. Can filter up to 50 vehicles at a time.

expand

enum<string>

Expand resources in the returned response

Available options:

vehicle,

driver,

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

results

object[]

required

results.id

string

required

results.sourceId

string

required

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

results.provider

enum<string>

required

Available options:

azuga,

bigroad,

conti-go,

eld-mandate,

eld-mandate-plus,

eld-mandate-hos,

eld-rider,

eldone,

envue-telematics,

eroad,

eva-eld,

attrix,

advantage-one,

argos,

fleet-profit-center,

gps-tracking-canada,

graybox-solutions,

gridline,

high-point-gps,

io-tab,

blue-arrow,

eagle-wireless,

fleet-complete-hub,

fleetistics,

fort-knox,

fm-eld,

geotab,

gofleet,

gogps,

gps-insight,

gpstab,

isaac,

ksk,

switchboard,

linxup,

coretex-360,

apollo,

apollo-eld,

apollo-compass,

top-tracking-system,

eld-mandate-prime,

hos-reporter-plus,

hos247,

black-bear,

columbus-eld,

phoenix-eld,

route-eld,

reliable-eld,

trust-eld,

abc-eld,

tempus-eld,

vlog-eld,

just-eld,

factor-eld,

moonlight-eld,

daily-eld,

dfl-eld,

hero-eld,

infinity-eld,

ampm-eld,

forza-eld,

action-eld,

state-elog,

dy-eld,

cobra-eld,

flash-elogs,

renaissance-eld,

robinhood-eld,

sr-eld,

speedline-eld,

eld-2-go,

captain-eld,

ironman-eld,

powertrucks-eld,

paragon-eld,

youlog-eld,

legacy-eld,

master-eld,

monarch-tracking,

motive,

mountain-eld,

omnitracs-es,

omnitracs-xrs,

omnitracs,

one-step-gps,

optima-eld,

pro-ride-eld,

pti-eld,

real-eld,

right-trucking,

roadstar,

routemate,

samsara,

sandbox,

sparkle-eld,

tx-eld,

surfsight,

tfm-eld,

transflo,

truckx,

tt-eld,

verizon-fleet,

verizon-reveal,

verizon,

webfleet,

xeld,

xplore-eld,

zonar,

geotab-att,

zippy-eld,

evo-eld,

ontime-eld,

intelli-shift,

id-eld,

max-eld,

asrit-solutions,

smartelds,

eld-books,

vulcansols,

motion-eld,

blue-horse-eld,

apex-ultima,

radical-eld,

rock-eld,

lytx,

blue-ink,

utech,

light-and-travel-eld,

lion-eight,

pop-eld,

netradyne,

people-net

results.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

results.vehicle

required

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

results.startedAt

string

required

ISO 8601 date

results.sourceType

string

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

results.driver

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

results.startLocation

object

results.endedAt

string

ISO 8601 date

results.endLocation

object

results.stats

object

results.cameraMedia

object

results.extensions

object

Includes data enriched via third-party vendors. See Extensions

results.raw

object[]

List of the raw data used to normalize the common model. Response schemas will vary by provider.

string

Cursor used for pagination.

List Devices Get Safety Event

curl --request GET \
  --url https://api.withterminal.com/tsp/v1/safety/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'

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

API Reference

Authentication

Vehicles

Drivers

Hours of Service

Trips

Devices

Safety

Groups

Trailers

IFTA

Connections

Data Management

Providers

Issues

Webhook Events

List Safety Events

Authorizations

Headers

Query Parameters

Response