{
"opencollection": "1.0.0",
"info": {
"name": "Samsara Safety API",
"version": "2024-11-18"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Safety",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Safety Events.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/fleet/safety-events",
"params": [
{
"name": "after",
"value": "",
"type": "query",
"description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results."
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00)."
},
{
"name": "endTime",
"value": "",
"type": "query",
"description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00)."
},
{
"name": "tagIds",
"value": "",
"type": "query",
"description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`"
},
{
"name": "parentTagIds",
"value": "",
"type": "query",
"description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`"
},
{
"name": "vehicleIds",
"value": "",
"type": "query",
"description": "A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`"
}
]
},
"docs": "Fetch safety events for the organization in a given time period. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.\n\nTo use this endpoint, select **Read Safety Events & Scores** under th"
},
{
"info": {
"name": "Fetches Safety Activity Event Feed",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/fleet/safety-events/audit-logs/feed",
"params": [
{
"name": "after",
"value": "",
"type": "query",
"description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results."
},
{
"name": "startTime",
"value": "",
"type": "query",
"description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00)."
}
]
},
"docs": "Get continuous safety events. The safety activity event feed offers a change-log for safety events. Use this endpoint to subscribe to safety event changes. See documentation below for all supported change-log types.\n\n| ActivityType | Description |\n| ----------- | ----------- |\n| CreateSafetyEventActivityType | a new safety event is processed by Samsara |\n| BehaviorLabelActivityType | a label is added or removed from a safety event |\n| CoachingStateActivityType | a safety event "
},
{
"info": {
"name": "Fetch Driver Safety Score",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/v1/fleet/drivers/:driverId/safety/score",
"params": [
{
"name": "driverId",
"value": "",
"type": "path",
"description": "ID of the driver. Must contain only digits 0-9."
},
{
"name": "startMs",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour."
},
{
"name": "endMs",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour."
}
]
},
"docs": "\n\n\nThis endpoint is still on our legacy API.\n\n\n\nFetch the safety score for the driver.\n\n Rate limit: 5 requests/sec (learn more about rate limits here). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If y"
},
{
"info": {
"name": "Fetch Harsh Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/v1/fleet/vehicles/:vehicleId/safety/harsh_event",
"params": [
{
"name": "vehicleId",
"value": "",
"type": "path",
"description": "ID of the vehicle. Must contain only digits 0-9."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the timestamp of a harsh event."
}
]
},
"docs": "\n\n\nThis endpoint is still on our legacy API.\n\n\n\nFetch harsh event details for a vehicle. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case"
},
{
"info": {
"name": "Fetch Vehicle Safety Scores",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/v1/fleet/vehicles/:vehicleId/safety/score",
"params": [
{
"name": "vehicleId",
"value": "",
"type": "path",
"description": "ID of the vehicle. Must contain only digits 0-9."
},
{
"name": "startMs",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour."
},
{
"name": "endMs",
"value": "",
"type": "query",
"description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour."
}
]
},
"docs": "\n\n\nThis endpoint is still on our legacy API.\n\n\n\nFetch the safety score for the vehicle. \n\n Rate limit: 5 requests/sec (learn more about rate limits here). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If"
}
]
}
],
"bundled": true
}