The identity and technical contract details declared by the specification.
SettingsGetComplianceSettingsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
HarshAccelSensitivityV2SettingsObjectResponseBody
object
The harsh acceleration sensitivity settings.
3 properties
SettingsGetDriverAppSettingsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
SettingsGetComplianceSettingsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
SafetySettingsObjectResponseBody
object
Safety settings for a single organization.
12 properties
12 required
SettingsPatchDriverAppSettingsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
SafetySettingsGetSafetySettingsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
SettingsGetDriverAppSettingsResponseBody
object
1 property
1 required
SafetySettingsGetSafetySettingsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
SafetySettingsGetSafetySettingsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
HarshBrakeSensitivityV2SettingsObjectResponseBody
object
The harsh brake sensitivity settings.
3 properties
SettingsPatchComplianceSettingsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
SettingsPatchDriverAppSettingsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
HarshAccelSensitivityGForceSettingsObjectResponseBody
object
The harsh acceleration sensitivity settings.
3 properties
SettingsGetDriverAppSettingsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
SettingsPatchDriverAppSettingsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
HarshEventSensitivityV2SettingsObjectResponseBody
object
The configurable sensitivity for Harsh Event Detection. Does not apply to CM11/12/22 devices.
3 properties
PolicyViolationsDetectionAlertSettingsObjectResponseBody
object
Enables detection of policy violations, surfaces events in Safety Inbox, and enables configurable alerts. While the feature is in beta, in-cab alerts are recom…
5 properties
SettingsGetDriverAppSettingsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
SettingsPatchComplianceSettingsRequestBody
object
Information set here will be displayed in roadside inspections and in the transferred US DOT datafile. Can be set or updated through the Samsara Settings page…
10 properties
SafetySettingsGetSafetySettingsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
SafetySettingsGetSafetySettingsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
FollowingDistanceDetectionAlertSettingsObjectResponseBody
object
Enables AI detection of tailgating or unsafe following distances, surfaces events in Safety Inbox, and enables configurable alerts. By default, Following Dista…
4 properties
InattentiveDrivingDetectionAlertSettingsObjectResponseBody
object
Enables AI detection of inattentive driving events.
4 properties
SafetySettingsGetSafetySettingsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
SettingsGetComplianceSettingsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
SettingsPatchComplianceSettingsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
SettingsPatchComplianceSettingsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
HarshTurnSensitivityGForceSettingsObjectResponseBody
object
The harsh turn sensitivity settings.
3 properties
SettingsPatchComplianceSettingsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
SettingsPatchDriverAppSettingsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
SettingsPatchDriverAppSettingsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
SettingsGetDriverAppSettingsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverAppSettingsGamificationConfigTinyObjectResponseBody
object
Gamification configuration for the Driver App.
1 property
SafetySettingsGetSafetySettingsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
SettingsPatchComplianceSettingsResponseBody
object
1 property
1 required
DriverAppSettingsResponseObjectResponseBody
object
The configuration settings for the Samsara Driver App. Can be set or updated through the Samsara Settings page or the API at any time.
6 properties
SafetySettingsGetSafetySettingsResponseBody
object
1 property
1 required
SettingsGetComplianceSettingsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
RollingStopDetectionAlertSettingsObjectResponseBody
object
AI event detection settings for the rolling stop behavior. Detection is available in vehicles with compatible dash cams.
2 properties
SettingsGetDriverAppSettingsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
SettingsGetComplianceSettingsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
SettingsPatchComplianceSettingsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverAppSettingsGamificationConfigTinyObjectRequestBody
object
Gamification configuration for the Driver App.
1 property
SettingsPatchDriverAppSettingsResponseBody
object
1 property
1 required
SettingsPatchDriverAppSettingsRequestBody
object
The configuration settings for the Samsara Driver App. Can be set or updated through the Samsara Settings page or the API at any time.
6 properties
SettingsGetDriverAppSettingsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
HarshEventSensitivitySettingsObjectResponseBody
object
The configurable sensitivity for Harsh Event Detection on CM11/CM12/CM22 devices. Sensitivity can be measured as a numeric g-force value or the following value…
3 properties
SettingsGetDriverAppSettingsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
SettingsPatchDriverAppSettingsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
SettingsComplianceResponseObjectResponseBody
object
Information set here will be displayed in roadside inspections and in the transferred US DOT datafile.
10 properties
SettingsGetComplianceSettingsResponseBody
object
1 property
1 required
SafetySettingsGetSafetySettingsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
SettingsGetComplianceSettingsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
SettingsPatchComplianceSettingsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
SettingsPatchComplianceSettingsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
VoiceCoachingSettingsObjectResponseBody
object
Enabling voice coaching will play messages for harsh events, speeding, and unbuckled seat belts.
4 properties
SettingsGetComplianceSettingsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
HarshTurnSensitivityV2SettingsObjectResponseBody
object
The harsh turn sensitivity settings.
3 properties
SettingsGetDriverAppSettingsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
SettingsPatchComplianceSettingsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverAppSettingsTrailerSelectionConfigTinyObjectResponseBody
object
Trailer selection setting configuration for the Driver App.
3 properties
SafetySettingsGetSafetySettingsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
SettingsPatchDriverAppSettingsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
SettingsGetComplianceSettingsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
SettingsPatchDriverAppSettingsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
SettingsPatchComplianceSettingsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
HarshBrakeSensitivityGForceSettingsObjectResponseBody
object
The harsh brake sensitivity settings.
3 properties
MobileUsageDetectionAlertSettingsObjectResponseBody
object
Enables AI detection of mobile usage events.
3 properties
SettingsGetDriverAppSettingsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
SettingsPatchDriverAppSettingsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
SettingsGetComplianceSettingsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
SafetyScoreConfigurationSettingsObjectResponseBody
object
The configurable safety infraction weights.
29 properties
ForwardCollisionDetectionAlertSettingsObjectResponseBody
object
Enables AI detection of near forward collisions, surfaces events in Safety Inbox, and enables configurable alerts. While the feature is in beta, it is only ena…
3 properties
SettingsGetComplianceSettingsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DistractedDrivingDetectionAlertSettingsObjectResponseBody
object
Enables AI detection of distracted driving, surfaces events in Safety Inbox, and enables configurable alerts. By default, Distracted Driving will impact the dr…
3 properties
SpeedingSettingsObjectResponseBody
object
Enables custom speeding levels.
2 properties
speedingSeverityLevelResponseBody
object
The settings for a specific speeding severity level.
4 properties
4 required
SettingsPatchDriverAppSettingsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
SettingsPatchComplianceSettingsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
SettingsGetDriverAppSettingsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
SafetySettingsGetSafetySettingsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverAppSettingsTrailerSelectionConfigTinyObjectRequestBody
object
Trailer selection setting configuration for the Driver App.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Samsara publishes across the network.
