Fields
id String Optional format: "uuid"
Active state
Allowed values: ACTIVE INACTIVE DELETED
created Datetime Optional
Timestamp when document was created.
changed Datetime Optional
Timestamp of when the last change occurred.
changedBy String Optional
Audit identification of who changed the document.
tenantId String Optional
Document tenant id.
reviewTime Datetime Optional
Timestamp when document was created.
locationExternalId String Optional
External id from source.
locationId String Optional
Location id.
rawReviewId String Optional
review unique id.
reviewerId String Optional
reviewer unique id.
reviewerName String Optional
Reviewer displayed name.
profilePhotoUrl String Optional
Profile photo of reviewer.
reviewerProfileUrl String Optional
Reviewer profile url
reviewerPhotos list of optional Strings Optional
Reviewer photos added.
reviewerVideos list of optional Strings Optional
Reviewer video added.
reportUrl String Optional
Report url for violation of the sources rules.
rating Double Optional
Customer rating.
Status of the reply
Allowed values: REPLIED SKIPPED NOT_REPLIED NOT_APPLICABLE IGNORED
isAnswered Boolean Optional
sourceUrl String Optional
URL of the review source
overall Double Optional
Overall score from all categories
sentimental Double Optional
Score for sentimental aspect of the review
atmosphere Double Optional
Score for atmosphere aspect of the review
service Double Optional
Score for service aspect of the review
food Double Optional
Score for food aspect of the review
informative Double Optional
Score for informativeness of the review
cleanliness Double Optional
Score for cleanliness aspect of the review
valueForMoney Double Optional
Score for value for money aspect of the review
willReturn Boolean Optional
Indicates likelihood of customer return
accommodatedSpecialNeeds Boolean Optional
Indicates if special needs were accommodated
acceptableWaitTime Boolean Optional
Indicates if wait time was acceptable
critical list of optional Strings Optional
List of critical aspects
positives list of optional Strings Optional
List of positive aspects
negatives list of optional Strings Optional
List of negative aspects
mostLiked list of optional Strings Optional
List of most liked aspects
leastLiked list of optional Strings Optional
List of least liked aspects
goodDishes list of optional Strings Optional
List of good dishes mentioned
badDishes list of optional Strings Optional
List of bad dishes mentioned
language String Optional
Language of the review
original String Optional
Original text of the review
translated String Optional
Translated text of the review
groupComposition String Optional
Description of the group composition
serviceTime String Optional
Description of the time of service
failToProcess Boolean Optional
Indicates if review failed to process
errorMessage String Optional
Error message if review failed to process
isTextInReview Boolean Optional
Indicates if there is text in the review
isDeleted Boolean Optional
Is deleted from source
Extracted categories in the review
title String Optional
The subject of the review
nps Double Optional
Net Promoter Score ranging from 0 - 10
ces Double Optional
Customer effort score 1-5
supportTicketId String Optional format: "uuid"
Support ticket id associated with the survey.
surveyTemplateId String Optional
Survey template ID that generated this review
