Legacy APIs

[legacy] Fetch harsh events

Note: This is a legacy endpoint, consider using this endpoint instead. The endpoint will continue to function as documented. > 🚧 This endpoint is still on our legacy API.

Fetch harsh event details for a vehicle.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

To use this endpoint, select Read Safety Events & Scores under the Safety & Cameras category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

get/v1/fleet/vehicles/{vehicleId}/safety/harsh_event

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Path parameters

vehicleIdinteger required

ID of the vehicle. Must contain only digits 0-9.

Query parameters

timestampinteger required

Timestamp in milliseconds representing the timestamp of a harsh event.

Response

Harsh event details.

downloadForwardVideoUrlstring

URL for downloading the forward facing video

downloadInwardVideoUrlstring

URL for downloading the inward facing video

downloadTrackedInwardVideoUrlstring

URL for downloading the tracked inward facing video

harshEventTypestring required

Type of the harsh event. One of: [Crash, Harsh Acceleration, Harsh Braking, Harsh Turn, ROP Engine, ROP Brake, YC Engine, YC Brake, Harsh Event]

incidentReportUrlstring required

URL of the associated incident report page

isDistractedboolean

Whether the driver was deemed distracted during this harsh event

Example response

{
  "downloadForwardVideoUrl": "https://samsara-dashcam-videos.s3.us-west-2.amazonaws.com/123/212123456789012/1539201872984/abC123De4-camera-video-segment-123456789.mp4?...",
  "downloadInwardVideoUrl": "https://samsara-dashcam-videos.s3.us-west-2.amazonaws.com/123/212123456789012/1539201872984/abC123De4-camera-video-segment-driver-123456789.mp4?...",
  "downloadTrackedInwardVideoUrl": "https://samsara-dashcam-videos.s3.us-west-2.amazonaws.com/123/212123456789012/1539201872984/abC123De4-camera-video-segment-driver-123456789.tracked.mp4?...",
  "harshEventType": "Harsh Braking",
  "incidentReportUrl": "https://cloud.samsara.com/o/1234/fleet/reports/safety/vehicle/212123456789012/incident/1539201882984",
  "isDistracted": true,
  "location": {
    "address": "350 Rhode Island St, San Francisco, CA",
    "latitude": 33.07614328,
    "longitude": -96.14907287
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.