>  Switch To Link 5 and API v2 Documentation

Reputations

Learn about the /reputations endpoint.

Reputation objects contain information related to the performance metrics of the user within a particular payroll account.


#The reputation object

Attributes
  • #
    idstring (uuid)

    Unique ID of the reputation object associated with a user's payroll account.

  • #
    accountstring (uuid)

    ID of the payroll account associated with the reputation object.

  • #
    employerstring

    The name of the company or entity that employs the user.

  • #
    ratingstring

    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_ratestring

    Average acceptance rate. Supplied by the gig platform (usually between 0 and 1).

  • #
    ontime_ratestring

    Average on-time rate. Supplied by the gig platform (usually between 0 and 1).

  • #
    achievementsarray of objects

    Various achievements returned by the gig platform. Can include url links to achievements, descriptions, points, or similar.

  • #
    created_atstring (timestamp)

    Time at which the reputation object was created. Timestamps follow the ISO 8601 standard.

  • #
    updated_atstring (timestamp)

    Time at which the reputation object was last updated. Timestamps follow the ISO 8601 standard.

  • #
    metadataobject

    Holds additional, often unstructured information about this data resource.



Example
1{
2  "id": "1f24c447-d645-41ab-afb7-e81b1db699c5",
3  "account": "810a054e-8133-4411-9722-12ebd6db040f",
4  "employer": "GigDrive",
5  "rating": "4.95",
6  "acceptance_rate": "0.86",
7  "ontime_rate": "0.80",
8  "achievements": [
9    {
10      "count": 1,
11      "label": "perfect_rating",
12      "badge_url": "https://media.website.com/1554853.png",
13      "description": "Earned on total 5-star ratings",
14      "points": "5"
15    }
16  ],
17  "created_at": "2020-09-10T17:12:49.715371Z",
18  "updated_at": "2020-09-11T08:52:38.138449Z",
19  "metadata": {}
20}

#Retrieve a reputation

get/v1/reputations/{id}
  • Retrieve a reputation object with the supplied ID.
  • This request returns a reputation object if you provided a valid identifier.
Path parameters
  • #
    idstring (uuid)
    required

    The identifier of the reputation to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v1/reputations/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "01805174-1bff-8dd4-63fe-9397ece30973",
3  "account": "01805161-796d-b3f1-a0c0-8250dc01efe4",
4  "employer": "udre",
5  "rating": "4.55",
6  "acceptance_rate": "0.92",
7  "ontime_rate": "0.93",
8  "achievements": [
9    {
10      "count": 2,
11      "label": "excellent_service",
12      "points": null,
13      "metadata": {},
14      "badge_url": "https://partners.udre.com/p3/badges/23d730df-8bd5-4929-ae97-01d07a434b85?in_app=true",
15      "description": "Excellent Service"
16    },
17    {
18      "count": 2,
19      "label": "great_conversation",
20      "points": null,
21      "metadata": {},
22      "badge_url": "https://partners.udre.com/p3/badges/02b67a89-5ac3-4c46-b366-382c96d74c8c?in_app=true",
23      "description": "Great Conversation"
24    },
25    {
26      "count": 3,
27      "label": "expert_navigator",
28      "points": null,
29      "metadata": {},
30      "badge_url": "https://partners.udre.com/p3/badges/5d21121f-4adb-4f07-ad26-5f58e71b3cb9?in_app=true",
31      "description": "Expert Navigator"
32    },
33    {
34      "count": 1,
35      "label": "cool_car",
36      "points": null,
37      "metadata": {},
38      "badge_url": "https://partners.udre.com/p3/badges/c1c6b917-4e03-4841-8205-1d87edeaef67?in_app=true",
39      "description": "Cool Car"
40    },
41    {
42      "count": 3,
43      "label": "above_and_beyond",
44      "points": null,
45      "metadata": {},
46      "badge_url": "https://partners.udre.com/p3/badges/58200f5e-e7b6-4983-8601-43655af2c9c3?in_app=true",
47      "description": "Above And Beyond"
48    },
49    {
50      "count": 1,
51      "label": "great_amenities",
52      "points": null,
53      "metadata": {},
54      "badge_url": "https://partners.udre.com/p3/badges/5cfe5d01-73e2-4c4c-b338-569fdd121df2?in_app=true",
55      "description": "Great Amenities"
56    }
57  ],
58  "created_at": "2022-04-22T13:26:45.504185Z",
59  "updated_at": "2022-04-22T13:26:47.939173Z",
60  "metadata": {}
61}

#List reputations

get/v1/reputations
  • List all reputation objects.
  • This request returns an object with a results property that contains an array of up to limit reputation objects.
Query parameters
  • #
    accountstring (uuid)
    optional

    Return only reputations for the account with the provided ID.

  • #
    userstring (uuid)
    optional

    Return only reputations for the user with the provided ID.

  • #
    limitinteger
    optional

    The number of reputation objects to be returned. The default is 10. Max value is 200.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v1/reputations?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "01805174-1bff-8dd4-63fe-9397ece30973",
4    "account": "01805161-796d-b3f1-a0c0-8250dc01efe4",
5    "employer": "GigDrive",
6    "rating": "4.55",
7    "acceptance_rate": "0.92",
8    "ontime_rate": "0.93",
9    "achievements": [
10      {
11        "count": 2,
12        "label": "excellent_service",
13        "points": null,
14        "metadata": {},
15        "badge_url": "https://partners.udre.com/p3/badges/23d730df-8bd5-4929-ae97-01d07a434b85?in_app=true",
16        "description": "Excellent Service"
17      },
18      {
19        "count": 2,
20        "label": "great_conversation",
21        "points": null,
22        "metadata": {},
23        "badge_url": "https://partners.udre.com/p3/badges/02b67a89-5ac3-4c46-b366-382c96d74c8c?in_app=true",
24        "description": "Great Conversation"
25      }
26    ],
27    "created_at": "2022-04-22T13:26:45.504185Z",
28    "updated_at": "2022-04-22T13:26:47.939173Z",
29    "metadata": {}
30  },
31  {
32    "id": "018047dd-b443-faf0-032e-716da12c09ab",
33    "account": "018047dd-8917-dee9-3000-b20bea907b35",
34    "employer": "GigAndGo",
35    "rating": "4.99",
36    "acceptance_rate": "0.91",
37    "ontime_rate": "0.88",
38    "achievements": [
39      {
40        "count": 1,
41        "label": "expert_navigator",
42        "points": null,
43        "metadata": {},
44        "badge_url": "https://partners.udre.com/p3/badges/921453d1-bdfc-4a00-80fb-3fb71b67b947?in_app=true",
45        "description": "Expert Navigator"
46      },
47      {
48        "count": 2,
49        "label": "cool_car",
50        "points": null,
51        "metadata": {},
52        "badge_url": "https://partners.udre.com/p3/badges/a09b1e01-e539-4b26-ae56-017ce6f86dee?in_app=true",
53        "description": "Cool Car"
54      }
55    ],
56    "created_at": "2022-04-20T16:45:53.604331Z",
57    "updated_at": "2022-04-20T16:45:56.188339Z",
58    "metadata": {}
59  }
60]
Updating Argyle status...
© 2024 Argyle Systems Inc.argyle.com