Get tag scores

Get safety scores and overall risk factors for tags.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Read Safety Events & Scores under the Safety & Cameras category when creating or editing an API token. Learn More.

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.

GET /safety-scores/tags

Get tag scores

cURL

curl --request GET \
  --url https://api.samsara.com/safety-scores/tags \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "behaviors": [
        {
          "behaviorType": "acceleration",
          "count": 5,
          "scoreImpact": -18.91020325321117
        }
      ],
      "driveDistanceMeters": 2207296,
      "driveTimeMilliseconds": 136997730,
      "speeding": [
        {
          "durationMilliseconds": 178773,
          "scoreImpact": -0.13049340306587562,
          "speedingType": "light"
        }
      ],
      "tagId": "5678",
      "tagScore": 92
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

endTime · string · required

End time in RFC 3339 format. Millisecond precision and timezones are supported. Includes trips that end before this timestamp.

startTime · string · required

Start time in RFC 3339 format. Millisecond precision and timezones are supported. Includes trips that end after this timestamp. Can be up to 1 year before endTime.

scoreType · enum<string> · required

Whether to calculate tag score with either all drivers or all vehicles in the tag. Deactivated drivers and unassigned trips are not included when calculating scores for drivers. Valid values: driver, vehicle

Available options: driver, vehicle

tagIds · string[]

Comma separated list of tag IDs to filter by. Include up to 100 IDs. Defaults to all tags.

after · string

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.

Response

200

application/json

OK response.

data · object[] · required

List of tag risk factors.

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes