Ratings

The Ratings data point provides information on the user's ratings as available in the Provider platform. If the platform selected has this data on the user, Smile retrieves this data for your records and also calculates a percentage rating based on the user's current rating and the maximum rating allowed on the platform.

Where available, Smile also retrieves other ratings-related information such as reviews and likes received, and jobs completed, as an additional data point for decision making.

After the user connects an Account via Smile, Smile retrieves the user's Ratings data (if available). You may listen for the appropiate events and webhooks (outlined below) in order to determine when their Identity data is ready.

The Rating object

AttributeTypeDescription
idstringUnique ID of the rating information on the Smile Network
currentRatingnumberThe current rating score of the user from the provider. Null if not available
maxRatingnumberThe maximum possible rating from the provider. Null if no rating score is available
calculatedPercentagenumberCurrent rating expressed as percentage. Calculated by currentRating / maxRating x 100. Null if no rating score is available
reviewsReceivednumberNumber of reviews received, if available from the provider. Null if not available
likesReceivednumberNumber of recommendations, likes, or kudos received, if available from the provider. Null if not available
jobsCompletednumberNumber of jobs completed on the platform, if available from the provider. Null if not available
metadataobjectContains data about this rating data point. See object below

The Meta Data object

AttributeTypeDescription
createdAtdate-timeDate/time when the account record was created
itemCreatedAtdate-timeDate/time when the rating record was created
accountId DeprecatedstringID of the user's account in the Smile Network
sourceIdstringID of the user's account or archive in the Smile Network
sourceTypestringIndicates whether the source associated with this object is an account or archive. Possible values: ACCOUNT, UPLOAD, ARCHIVE
providerIdstringID of the data provider of the user's account
userIdstringID of the user on the Smile Network

Sample Rating data

{
    "id": "r-123abc456def789abc123def456abc78",
    "currentRating": 4,
    "maxRating": 5,
    "calculatedPercentage": 80,
    "reviewsReceived": 27,
    "likesReceived": 82,
    "jobsCompleted": 125,
    "metadata": {
        "createdAt": "2022-09-02T23:36:12Z",
        "itemCreatedAt": "2022-08-24T05:24:37Z",
        "sourceId": "a-123abc456def789abc123def456abc78",
        "sourceType": "ACCOUNT",
        "userId": "tenantId-123abc456def789abc123def456abc78",
        "providerId": "xyzgigcompany"
    }
}

Endpoints

Endpoint
List all ratingsGET /ratings
Retrieve one ratingGET /ratings/{id}

Webhooks

RATING_ADDED

Sent when ratings data about a user is added from the provider.

{
  "id": "et-123abc456def789abc123def456abc78",
  "version": 1,
  "type": "RATING_ADDED",
  "createdAt": "2021-04-14T09:30:24Z",
  "data": {
    "userId": "tenantId-123abc456def789abc123def456abc78",
    "accountId": "a-123abc456def789abc123def456abc78",
    "ratingId": "r-123abc456def789abc123def456abc78",
    "providers": [
      "abccorp"
    ]
  }
}

TASK_FINISHED

Sent when the full data sync task process for a user's account is finished.

{
  "id": "et-123abc456def789abc123def456abc78",
  "version": 1,
  "type": "TASK_FINISHED",
  "createdAt": "2021-04-14T09:30:24Z",
  "data": {
    "userId": "tenantId-123abc456def789abc123def456abc78",
    "sourceId": "a-123abc456def789abc123def456abc78",
    "sourceType": "ACCOUNT",
    "providers": [
      "abccorp"
    ],
    "datapoints": [
      "IDENTITIES",
      "RATINGS"
    ]
  }
}