Settings

Get safety settings

Get safety settings

<b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

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>

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.

get/fleet/settings/safety

Request

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

Response

OK response.

Example response

{
  "data": [
    {
      "defaultVehicleType": "heavyDuty",
      "distractedDrivingDetectionAlerts": {
        "inattentiveDrivingDetectionAlerts": {
          "hasInCabAudioAlertsEnabled": true,
          "isEnabled": true,
          "severity": "low",
          "speedingThresholdMph": 10
        },
        "isEnabled": true,
        "mobileUsageDetectionAlerts": {
          "hasInCabAudioAlertsEnabled": true,
          "isEnabled": true,
          "speedingThresholdMph": 5
        }
      },
      "followingDistanceDetectionAlerts": {
        "durationMs": 15000,
        "hasInCabAudioAlertsEnabled": true,
        "isEnabled": true,
        "speedingThresholdMph": 35
      },
      "forwardCollisionDetectionAlerts": {
        "hasInCabAudioAlertsEnabled": true,
        "isEnabled": true,
        "sensitivity": "near"
      },
      "harshEventSensitivity": {
        "harshAccelSensitivityGForce": {
          "heavyDuty": "0.29",
          "lightDuty": "0.33",
          "passenger": "0.43"
        },
        "harshBrakeSensitivityGForce": {
          "heavyDuty": "0.29",
          "lightDuty": "0.33",
          "passenger": "0.43"
        },
        "harshTurnSensitivityGForce": {
          "heavyDuty": "0.29",
          "lightDuty": "0.33",
          "passenger": "0.43"
        }
      },
      "harshEventSensitivityV2": {
        "harshAccelSensitivity": {
          "heavyDuty": "normal",
          "lightDuty": "normal",
          "passenger": "normal"
        },
        "harshBrakeSensitivity": {
          "heavyDuty": "normal",
          "lightDuty": "normal",
          "passenger": "normal"
        },
        "harshTurnSensitivity": {
          "heavyDuty": "normal",
          "lightDuty": "normal",
          "passenger": "normal"
        }
      },
      "policyViolationsDetectionAlerts": {
        "eventsAvailableForTesting": [
          "smoking",
          "eatingDrinking"
        ],
        "eventsToCoach": [
          "noSeatbelt",
          "noMask"
        ],
        "hasInCabAudioAlertsEnabled": true,
        "isEnabled": true,
        "speedingThresholdMph": 5
      },
      "rollingStopDetectionAlerts": {
        "isEnabled": true
      },
      "safetyScoreConfiguration": {
        "aiInattentiveDrivingDetectionWeight": 2,
        "crashWeight": 1,
        "followingDistanceWeight": 2,
        "harshAccelWeight": 1,
        "harshBrakeWeight": 1,
        "harshTurnWeight": 1,
        "heavySpeedingWeight": 1,
        "maxSpeedWeight": 1,
        "moderateSpeedingWeight": 1,
        "severeSpeedingWeight": 1
      },
      "safetyScoreTarget": 90,
      "speedingSettings": {
        "severityLevels": [
          {
            "durationMs": 60,
            "isEnabled": true,
            "severityLevel": "light",
            "speedOverLimitThreshold": 10
          }
        ],
        "unit": "milesPerHour"
      },
      "voiceCoaching": {
        "eventsToCoach": [
          "crash",
          "inCabSpeeding",
          "maximumSpeed"
        ],
        "isEnabled": true,
        "language": "english",
        "speedingThresholdMph": 10
      }
    }
  ]
}

Changes

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