Versions Compared

Old Version 7

changes.mady.by.user Renata Rusecka

Saved on

compared with

New Version Current

changes.mady.by.user Renata Rusecka

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleResponse description
Field
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.

room_category

Reviewer’s attribute.

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

room_number

Reviewer’s attribute.

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

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.

Statistics

Expand
titleResponse description
Field
Description

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

Feedbacks

Expand
titleResponse description
Field
Description

id

Internal ID of a feedback questionnaire

name

The name of a feedback questionnaire. This is set in the questionnaire settings.

pagination

current_page

The current page returned. Integer value.

total_pages

The total number of pages available to view. Can be changed using the 'limit' parameter. Integer value.

total_items

The total number of items found by this search over all pages. Integer value.

A description of an item in the "items" array.

Field
Type
Optional
Description

id

Integer

No

Internal ID of a feedback questionnaire.

language

String

No

One of these language codes:
de, en, es, fr, nl, cs, da, hu, it, pl, pt, ru, sr, sv, ar, zh, ja, fi, no

created_date

String

No

The date and time the questionnaire was created in Berlin local time.

Provided in the format: 2019-01-10 14:12:13

questionnaire

id

Integer

No

Internal id of a feedback questionnaire.

name

String

No

The name of a feedback questionnaire. This is set in the questionnaire settings.

author

name

String

Yes

The first and last name of a feedback's author.

email

String

Yes

The email of the of a feedback's author.

age

String

Yes

The age of the of a feedback's author.

meta

traveller_type

String

No

The feedback author's traveller type. One of these strings:

business, alone, couple, friends, family, group

room_number

String

Yes

The feedback author's room number.

arrival_date

String

Yes

The arrival date of the feedback's author in Berlin local time.

Provided in the format: 2019-01-10 14:12:13

departure_date

String

Yes

The departure date of the feedback's author in Berlin local time.

Provided in the format: 2019-01-10 14:12:13

pms_reservation_id

String

Yes

The optionally available reservation id

pms_guest_profile_id

String

Yes

The optionally available guest profile id

question_answers

question

id

Integer

No

Internal id of a feedback's question.

type

String

No

The question's type. One of the following strings: 

overall_comment, text, choice, rating, nps, email, traveller_type, age, name, newsletter_signup, date, date_range

label

String

No

The question's text in your account's default language.

mapping

String

Yes

The optionally configured mapping for this question.

answer

rating

Integer

Yes

If the question type is 'rating', the rating the author chose.

The rating value will always be an integer between 1 and 5.

text

String or Null

Yes

If the question answer contains any type of 'text', a text answer the author wrote.

choices

Array

Yes

If the question type is 'choice', an array containing the answers to the choice question. Will optionally contain a "mapping" that was configured for this choice.

date

String

Yes

A date in format "YYYY-MM-DD" in case its a date question.

date_range

Object

Yes

A date range with nested keys "start" and "end" in "YYYY-MM-DD" format in case its a "date_range" question.

sub_question_answers

Array

No

Contains 'question', 'answer' and 'sub_question_answers' elements for each sub question.