Attribute | Type | Description |
---|---|---|
author.id | string | Review site's unique identifier for the author. |
author.name | string | Name of the author. |
responses | array | Response from the business to the reviewer. |
responses[].body | string | Response's body |
responses[].createdAt | string | When the response was created. |
responses[].siteAuthorName | string | Name of the response author. |
uid | string | Podium unique identifier for review. |
locations | array | Podium location that the review is associated to. |
locations[].uid | string | Podium unique identifier for location. |
review.body | string | Comments left as a part of the review. |
review.url | string | URL for the individual review that was posted. |
review.rating | number | Rating on 5 star scale. 5 = high; 1 = low. Note that recommendations have adjusted scores of 5 for recommended; 1 for not recommended. |
review.siteName | string | Name of the review site. |
review.siteReviewId | string | Review site's unique identifier for the review posted. |
createdAt | string | When the review was created. |
updatedAt | string | When the review was last updated. |
attributions | array | Podium user that has been attributed to the review rating e.g. technician that visited the client would be associated to the review rating. |
attributions[].userUid | string | Podium unique identifier for user. |
attributions[].apiClientUid | string | Podium unique identifier for api client. |
attributions[].reviewInvitationUid | string | Podium unique identifier for review invitation. |
isRecommendation | boolean | Whether or not the review is recommendation based, as opposed to being a star rating. |
needsResponse | boolean | Whether or not the review needs a response. |
{
"author": {
"id": "2412341",
"name": "Joe Orange"
},
"responses": [
{
"body": "Thanks Joe for leaving us a review!",
"createdAt": "2015-01-23T23:50:07Z",
"siteAuthorName": "John Apple"
}
],
"uid": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"review": {
"body": "We love our new sofa from Sofa Plus! It is comfortable and stylish.",
"url": "https://www.podium.com/",
"rating": 5,
"siteName": "Google",
"siteReviewId": "2390afs293fj"
},
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z",
"attributions": [
{
"userUid": "00000000-0000-0000-0000-000000000000",
"apiClientUid": "00000000-0000-0000-0000-000000000000",
"reviewInvitationUid": "00000000-0000-0000-0000-000000000000"
}
],
"isRecommendation": false,
"needsResponse": false
}