Response fields description

totalCount

The total number of reviews available to paginate over

reviews

hotel_name

The name of the hotel owning the review

author

The anonymized name of review's author, returns "null" if there is no value

review_id

An identifier for the review

review_source

The source of the review, e.g. Customer Alliance, Holiday Check, etc

average_rating_normalized

The review score as a percentage

average_rating

The review score as it appeared in its original format

reviewer_type

The type of the review, if the review source supports them

language

The language of the review

published

Only available for Customer Alliance reviews, shows if the review is published or not

hotelier_comment

A comment from hotelier

reviewer_comment

Displayed depending on access level scope on the API key:

• owner - will see only review texts for Customer Alliance

• third_party - will see only customer alliance review texts

• third_party_review_texts - will see all review texts

Please note scopes are assigned internally.

reviewer_comment_positive

See reviewer_comment above

reviewer_comment_negative

See reviewer_comment above

age

The age of the user, if there is no value for age then null is going to be shown

pms_guest_id

Only shown if the Access level scope on the API key is set to owner.

Please note scopes are assigned internally.

review_date

The date the review was created

email

The email address of the reviewer

category_ratings

Contains a review rating category information.

The keys of these are the default category names.  For a list of available categories please check the Statistics API.

Included with each rating category is its translated name, its rating and any comment that the guest left for that category.

start_date

Reviews left on or after this day are included in the statistics. In the format YYYY-MM-DD.

end_date

Reviews left on or before this day are included in the statistics. In the format YYYY-MM-DD.

comment_rate

The fraction of reviews left with a comment out of 10.

category_statistics

Statistics for each configured category in the customer's statistics. See /statistics/v1/categories.json for the full list of categories returned.

reviewCount or review_count

Count of reviews available within the category or topic

reviewCountPositive or positive_review_count

Count of positive reviews available within the category or topic

reviewCountNeutral or neutral_review_count

Count of neutral reviews available within the category or topic

reviewCountNegative or negative_review_count

Count of negative reviews available within the category or topic

averageRating or average_rating

The review score as it appeared in its original format