getScoreForGroup
get
getScoreForGroup
Resource URL
https://api-sandbox.arity.com/drivinginsights/v1/orgs/{orgId}/groups/{groupId}/score
Header Parameters
| Name | Values | Description |
|---|---|---|
| Content-Type |
|
|
|
Authorization
(required) |
Value should be the word Bearer followed by a space and then the token (e.g., Bearer CW8abh5JkxZ5KYdAQQH0p9fTAicq). To generate a token, use the OAuth API. |
orgId Unique ID for the organization, provided by Arity. null true
groupId Unique ID for the group. null true
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Response Error Details
-
HTTP CodeError CodeDescription
-
400400
400.05.403 - Please provide valid score type
-
404404
404.05.402 - Score for group not found 404.05.404 - Group does not have enough trips to be scored
-
503503
503.05.901 - Service Unavailable
Resource Summary |
|
|
Security |
None |
|
Category |
score-controller |
| Name | Type | Description |
|---|
| Name | Type | Description |
|---|---|---|
| data .score | integer | Driving score generated by the scoring model. Value will be a number 1-100, where a higher score represents a safer driver. Updated daily. |
| data .orgId | string | Unique ID of the organization. Provided by Arity. |
| data .groupId | string | Unique ID of the group. |
| data .modelName | string | Name of the scoring model being used. Provided by Arity. |
| data .timeCalculated | string | Date and time when the score was last calculated. Scores are updated daily. |
| data .users | array | Array of user scores |
| data .users[] .userId | string | Unique ID of the user. |
| data .users[] .score | integer | Driving score generated by the scoring model. Value will be a number 1-100, where a higher score represents a safer driver. Updated daily. |
| data .users[] .timeCalculated | string | Date and time when the score was last calculated. Scores are updated daily. |
| data .users[] .earliestActiveDatetime | string | Earliest trip included in scoring within the past year. |
| data .users[] .latestActiveDatetime | string | Most recent trip included in scoring. |
| data .users[] .tripCount | integer | Number of trips included in scoring for the user. |
| data .users[] .observedDays | integer | Number of days between latestActiveDatetime and earliestActiveDatetime. |
| data .users[] .totalMiles | number | Sum of the mileage of all trips included in scoring for the user. |
Working...