Ratings

Achievement and task summary details for gig employments.

#The rating object

Attributes
  • #
    idstring (uuid)

    Unique ID of the rating object.

  • #
    accountstring (uuid)

    ID of the account associated with the rating object.

  • #
    ratingstring

    A normalized average of the user's ratings between 0 and 5. Overall average, as payroll system do not typically provide ratings information for individual events.

  • #
    acceptance_ratestring

    Percent of the time the user accepts a task. Decimal between 0 and 1.

  • #
    ontime_ratestring

    Percent of the time the user completes a task on time. Decimal between 0 and 1.

  • #
    achievementsarray of objects

    Individual ratings or achievement information, sorted into relevant key:value pairs. Varies by gig platform.

  • #
    employerstring

    Name of the user's employer.

  • #
    created_atstring (datetime)

    Timestamp (ISO 8601) when the rating object was created.

  • #
    updated_atstring (datetime)

    Timestamp (ISO 8601) when a property value of the rating object most recently changed.

  • #
    metadataobject

    Additional, non-categorized information.

Example
1{
2  "id": "0176a5bd-6ed4-1a21-8661-32bc3546e6de",
3  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4  "rating": "4.98",
5  "acceptance_rate": "0.91",
6  "ontime_rate": "0.94",
7  "achievements": [
8    {
9      "count": 3,
10      "label": "excellent_service",
11      "points": null,
12      "metadata": {},
13      "badge_url": "www.partner.com/badgeinfo",
14      "description": "Excellent Service"
15    },
16    {
17      "count": 1,
18      "label": "great_amenities",
19      "points": null,
20      "metadata": {},
21      "badge_url": "www.partner.com/badgeinfo",
22      "description": "Great Amenities"
23    }
24  ],
25  "employer": "GigAndGo",
26  "created_at": "2023-03-15T13:19:55.723Z",
27  "updated_at": "2023-03-15T13:19:55.723Z",
28  "metadata": {}
29}

#Retrieve a rating

get/v2/ratings/{id}

Retrieves a rating object.

Path parameters
  • #
    idstring (uuid)
    required

    ID of the rating object to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/ratings/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "0176a5bd-6ed4-1a21-8661-32bc3546e6de",
3  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4  "rating": "4.98",
5  "acceptance_rate": "0.91",
6  "ontime_rate": "0.94",
7  "achievements": [
8    {
9      "count": 1,
10      "label": "excellent_service",
11      "points": null,
12      "metadata": {},
13      "badge_url": "www.partner.com/badgeinfo",
14      "description": "Excellent Service"
15    },
16    {
17      "count": 1,
18      "label": "great_amenities",
19      "points": null,
20      "metadata": {},
21      "badge_url": "www.partner.com/badgeinfo",
22      "description": "Great Amenities"
23    }
24  ],
25  "employer": "GigAndGo",
26  "created_at": "2023-03-15T13:19:55.723Z",
27  "updated_at": "2023-03-15T13:19:55.723Z",
28  "metadata": {}
29}

#List all ratings

get/v2/ratings

Returns an array of all rating objects.

Query parameters
  • #
    accountstring (uuid)
    optional

    Filter by account ID.

  • #
    userstring (uuid)
    optional

    Filter by user ID.

  • #
    limitinteger
    optional

    Number of rating objects returned per page. Default: 10. Maximum: 200.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/ratings?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "0186b4eb-1e33-bb38-a45a-1db105b5bed0",
4    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
5    "rating": "4.14",
6    "acceptance_rate": "0.87",
7    "ontime_rate": "0.85",
8    "achievements": [
9      {
10        "count": 3,
11        "label": "excellent_service",
12        "points": "300",
13        "award": null,
14        "description": "Excellent Service",
15        "metadata": {}
16      },
17      {
18        "count": 2,
19        "label": "speed_demon",
20        "points": "200",
21        "award": "Speed Demon",
22        "description": "Fast Service",
23        "metadata": {}
24      }
25    ],
26    "employer": "GigAntic",
27    "created_at": "2023-03-15T11:15:20.359Z",
28    "updated_at": "2023-03-15T11:15:20.359Z",
29    "metadata": {}
30  },
31  {
32    "id": "0176a5bd-6ed4-1a21-8661-32bc3546e6de",
33    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
34    "rating": "4.98",
35    "acceptance_rate": "0.91",
36    "ontime_rate": "0.94",
37    "achievements": [
38      {
39        "count": 3,
40        "label": "excellent_service",
41        "points": null,
42        "metadata": {},
43        "badge_url": "www.partner.com/badgeinfo",
44        "description": "Excellent Service"
45      },
46      {
47        "count": 1,
48        "label": "great_amenities",
49        "points": null,
50        "metadata": {},
51        "badge_url": "www.partner.com/badgeinfo",
52        "description": "Great Amenities"
53      }
54    ],
55    "employer": "GigAndGo",
56    "created_at": "2023-03-15T13:19:55.723Z",
57    "updated_at": "2023-03-15T13:19:55.723Z",
58    "metadata": {}
59  }
60]
Updating Argyle status...
┬ę 2024 Argyle Systems Inc.argyle.com