Learn about the /reputations
endpoint.
Reputation objects contain information related to the performance metrics of the user within a particular payroll account.
Attributes
Attribute | Type | Description |
---|---|---|
id | string uuid | Unique ID of the reputation object associated with a user's payroll account. |
account | string uuid | ID of the payroll account associated with the reputation object. |
employer | string | The name of the company or entity that employs the user. |
rating | string decimal | A normalized average rating for all activities performed. Will contain a value between 0 and 5. This value is only available as an average for the user. Activity level ratings are rarely exposed by payroll providers and are usually unavailable. |
acceptance_rate | string decimal | Average acceptance rate. Contain a value as supplied by the payroll provider—this value is usually between 0 and 1. |
ontime_rate | string decimal | Average on-time rate. Will contain a value as supplied by the payroll provider—this value is usually between 0 and 1. |
achievements | objects | An array containing key-value pairs of any potential achievements returned by the payroll provider. This can include achievements urls, descriptions, points, and the like. |
metadata | string | Metadata holds additional available, often unstructured, information about this data resource. |
created_at | string timestamp | Time at which the reputation object was created. Timestamps follow the ISO 8601 standard. |
updated_at | string timestamp | Time at which the reputation object was last updated. Timestamps follow the ISO 8601 standard. |
Endpoints
These are the endpoints available for reputations
.
Endpoints |
---|
Retrieve a reputation - GET /reputations/:id |
List reputations - GET /reputations |
Example object
{
"id": "1f24c447-d645-41ab-afb7-e81b1db699c5",
"account": "810a054e-8133-4411-9722-12ebd6db040f",
"employer": "uber",
"created_at": "2020-09-10T17:12:49.715371Z",
"updated_at": "2020-09-11T08:52:38.138449Z",
"rating": "4.95",
"acceptance_rate": "0.86",
"ontime_rate": "0.80",
"achievements": [
{
"count": 1,
"label": "perfect_rating",
"badge_url": "https://media.website.com/1554853.png",
"description": "Earned on total 5-star ratings",
"points": "5",
"metadata": {}
}
],
"metadata": {}
}