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.
  • #
    rewardsarray of objects
    Rewards program information.
  • #
    program_namestring

    Name of the rewards program.

  • #
    tierstring

    Current rewards program tier or status.

  • #
    valid_throughstring
    Date until the current tier or status is valid.
  • #
    pointsstring
    Points earned in the current rewards period.
  • #
    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  "rewards": [
26    {
27      "program_name": "Driver Rewards Program",
28      "tier": "Elite",
29      "valid_through": "2026-05-15",
30      "points": "117"
31    }
32  ],
33  "employer": "GigAndGo",
34  "created_at": "2023-03-15T13:19:55.723Z",
35  "updated_at": "2023-03-15T13:19:55.723Z",
36  "metadata": {}
37}

#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  "rewards": [
26    {
27      "program_name": "Driver Rewards Program",
28      "tier": "Elite",
29      "valid_through": "2026-05-15",
30      "points": "117"
31    }
32  ],
33  "employer": "GigAndGo",
34  "created_at": "2023-03-15T13:19:55.723Z",
35  "updated_at": "2023-03-15T13:19:55.723Z",
36  "metadata": {}
37}

#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    "rewards": [
27      {
28        "program_name": "Star Delivery Program",
29        "tier": "Bronze",
30        "valid_through": "2025-12-31",
31        "points": null
32      }
33    ],
34    "employer": "GigAntic",
35    "created_at": "2023-03-15T11:15:20.359Z",
36    "updated_at": "2023-03-15T11:15:20.359Z",
37    "metadata": {}
38  },
39  {
40    "id": "0176a5bd-6ed4-1a21-8661-32bc3546e6de",
41    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
42    "rating": "4.98",
43    "acceptance_rate": "0.91",
44    "ontime_rate": "0.94",
45    "achievements": [
46      {
47        "count": 3,
48        "label": "excellent_service",
49        "points": null,
50        "metadata": {},
51        "badge_url": "www.partner.com/badgeinfo",
52        "description": "Excellent Service"
53      },
54      {
55        "count": 1,
56        "label": "great_amenities",
57        "points": null,
58        "metadata": {},
59        "badge_url": "www.partner.com/badgeinfo",
60        "description": "Great Amenities"
61      }
62    ],
63    "rewards": [
64      {
65        "program_name": "Driver Rewards Program",
66        "tier": "Elite",
67        "valid_through": "2026-05-15",
68        "points": "117"
69      }
70    ],
71    "employer": "GigAndGo",
72    "created_at": "2023-03-15T13:19:55.723Z",
73    "updated_at": "2023-03-15T13:19:55.723Z",
74    "metadata": {}
75  }
76]
Updating Argyle status...
© 2025 Argyle Systems Inc.argyle.com