Display reviews on your website

This API allows you to retrieve the reviews collected via the CRM Experience satisfaction surveys for display on your website.

Reviews created modified deleted

This method will return a list of review identifiers that have been created or modified over the selected period. This way you can maintain your website up to date, even with a review deleted inside the CRM.

These identifiers can then be used with the Reviews details method to retrieve the details of the review.

Request

GET

https://interface.experience-hotel.com/api/xp-reviews/created-modified-deleted?date_start=2021-02-01&date_end=2022-02-08

Param	Format	Required
date_start	YYYY-MM-DD	Required
date_end	YYYY-MM-DD	Required

Response

Status Code 200 OK

{
  "created_or_modified": [
    5808733,
    5808736
  ],
  "deleted": []
}

Reviews details

This method will return the details of the reviews. It takes as parameter reviews identifiers retrieved with the created-modified-deleted method, with a maximum of 25 identifiers per call.

Request

GET

https://interface.experience-hotel.com/api/xp-reviews/details?list=5808733,5808736

Response

Status Code 200 OK

{
  "reviews_details": [
    {
      "id": 5808733,
      "partner_property_id": null,
      "experience_property_id": 1234,
      "property_name": "Hotel Test",
      "publishable": 1,
      "reviewed_at": "2022-01-13",
      "arrival_date": "2022-02-10",
      "departure_date": "2022-02-20",
      "segment": "",
      "purpose": "",
      "rating_min": 0,
      "rating_max": 10,
      "customer": {
        "email": "[e-mail]",
        "firstname": "BERNARD",
        "lastname": "HOOVER",
        "country": "GB",
        "language": "en"
      },
      "booking_properties": [],
      "customer_properties": [],
      "review_free_text": "",
      "ratings": [
        {
          "internal_id": 11125,
          "code": "general",
          "rating": 10,
          "text_pro": "",
          "text_con": ""
        },
        {
          "internal_id": 11123,
          "code": "staff",
          "rating": 10,
          "text_pro": "Great Team !!!",
          "text_con": ""
        },
        {
          "internal_id": 11120,
          "code": "amenities",
          "rating": 10,
          "text_pro": "",
          "text_con": ""
        },
        {
          "internal_id": 12204,
          "code": "room_comfort",
          "rating": 10,
          "text_pro": "",
          "text_con": ""
        },
        {
          "internal_id": 11119,
          "code": "cleanliness",
          "rating": 10,
          "text_pro": "",
          "text_con": ""
        },
        {
          "internal_id": 11122,
          "code": "hotel_comfort",
          "rating": 10,
          "text_pro": "",
          "text_con": ""
        },
        {
          "internal_id": 11121,
          "code": "location",
          "rating": 10,
          "text_pro": "",
          "text_con": ""
        },
        {
          "internal_id": 11124,
          "code": "valueformoney",
          "rating": 10,
          "text_pro": "",
          "text_con": ""
        },
        {
          "internal_id": 13757,
          "code": "wifi",
          "rating": 10,
          "text_pro": "",
          "text_con": ""
        },
        {
          "internal_id": 12934,
          "code": "breakfast",
          "rating": 10,
          "text_pro": "Très bon !",
          "text_con": ""
        }
      ],
      "management_response": null
    }
  ]
}

Fields available

Fields	Type	Description
id	Numeric	Experience CRM internal Id for the Satisfaction Survey
partner_property_id	Numeric	Property management code at the partner. If you need this field with your own property ID, you can send us the list of properties with their ID at your place, and we can send it back to you for each reservation.
experience_property_id	Numeric	Experience CRM Id for the property
property_name	String	Property Name in Experience CRM
publishable	Numeric	0: The review cannot be shown on a website. 1: The review can be shown on a website.
reviewed_at	Date
arrival_date	Date	Guest arrival date
departure_date	Date	Guest departure date
segment	String	Segment of the Stay
purpose	String	Purpose of the Stay
rating_min	Numeric	Minimum rating setup for the property
rating_max	Numeric	Maximum rating setup for the property
customer	Object	See Customer object
booking_properties	Object	Additional booking properties. Depending on the property config.
customer_properties	Object	Additional customer properties. Depending on the property config.
review_free_text	String	General review comment
ratings	Array	Array of rating
management_response	String	Response given by the property

Customer object

Fields	Type	Description
email	String	Guest email
firstname	String	Guest firstname
lastname	String	Guest lastname
country	String	Guest country code
language	String	Guest language code

Ratings

Each rating object corresponds to a question asked to the guest in the Satisfaction survey.

Fields	Type	Description
internal_id	Numeric	CRM Internal id for the question
code	String	Analitycs code for the question
rating	Numeric	Rating given by the guest for this question
text_pro	String	Positive comment
text_con	String	Nagative comment

Reviews summary

This method can be used to get a summary of the average scores for each question in the CRM Experience satisfaction survey.

The average scores communicated with this method will concern all the answers obtained to the satisfaction survey for the selected period.

Request

GET

https://interface.experience-hotel.com/api/xp-reviews/summary?date_start=2021-02-01&date_end=2022-02-08

Param	Format	Required
date_start	YYYY-MM-DD	Required
date_end	YYYY-MM-DD	Required

Response

Status Code 200 OK

{
  "summary": [
    {
      "question_code": "general",
      "rating_count": 40,
      "rating_average": 8.3
    },
    {
      "question_code": "staff",
      "rating_count": 34,
      "rating_average": 9.2
    },
    {
      "question_code": "amenities",
      "rating_count": 35,
      "rating_average": 8.2
    },
    {
      "question_code": "room",
      "rating_count": 34,
      "rating_average": 8.2
    },
    {
      "question_code": "cleanliness",
      "rating_count": 35,
      "rating_average": 8.5
    },
    {
      "question_code": "hotel_comfort",
      "rating_count": 35,
      "rating_average": 8.5
    },
    {
      "question_code": "location",
      "rating_count": 35,
      "rating_average": 8.7
    },
    {
      "question_code": "valueformoney",
      "rating_count": 35,
      "rating_average": 8.7
    },
    {
      "question_code": "wifi",
      "rating_count": 31,
      "rating_average": 8.8
    }
  ]
}

question_code	String	Analytic code for the question
rating_count	Numeric	Number of answers for the question
rating_average	Numeric	Average rating