# Guest Satisfaction
For every completed satisfaction survey, our API delivers comprehensive data, including all information related to the responding guest, details of their stay, and, importantly, their responses to each survey question.
This API has been designed to allow you to retrieve the reviews of a single establishment or of a whole group of establishments at once, according to your needs.
### Request
**GET**
{% code overflow="wrap" %}
```
https://interface.experience-hotel.com/api/statistics/guests-satisfaction/?date_start=2023-01-01&date_end=2024-01-31
```
{% endcode %}
| Param | Format | Required |
| ----------- | ---------- | -------- |
| date\_start | YYYY-MM-DD | Required |
| date\_end | YYYY-MM-DD | Required |
### Response
Status Code 200 OK
{% code title="JSON" overflow="wrap" %}
```json
[
{
"configuration": {
"business_name": "Hôtel Test",
"business_id": 1234,
"rating_min": 1,
"rating_max": 5
},
"stay": {
"booked_at": "2023-10-03T06:18:46.000000Z",
"arrival_date": "2023-11-28T23:00:00.000000Z",
"arrival_day": "wednesday",
"departure_date": "2023-11-29T23:00:00.000000Z",
"departure_day": "thursday",
"duration": 1,
"presence_days": [
"wednesday",
"thursday"
],
"room_number": [
"015"
],
"room_type": [
"TWIN"
],
"rate_code": "MYRATECODE",
"booking_additional_properties": [
{
"name": "segment",
"value": "BOOKING.COM"
},
{
"name": "origine",
"value": "my-origin"
}
]
},
"segment": null,
"purpose": "family_visit",
"customer": {
"email": "test@test.com",
"title": "MME",
"firstname": "Jane",
"lastname": "Doe",
"language": "fr",
"birthdate": "1970-05-19",
"age_at_time_of_stay": 53,
"addr_street": null,
"addr_city": null,
"addr_zipcode": null,
"addr_country": "FR",
"continent": "Europe",
"nationality": "FR",
"mobile_phone": "+33601010101",
"phone": "0601010101",
"number_of_stays": 1,
"often_travel_to_city": false,
"customer_custom_properties": [],
"customer_additional_properties": []
},
"internal_id": 123456,
"response_date": "2023-12-02T20:00:04.000000Z",
"average_score": 5,
"ratings": [
{
"internal_id": 1621,
"deleted_question": false,
"code": "general",
"question_titles": [
{
"name": "Overall rating of your stay",
"code": "en"
}
],
"rating": 5,
"text_pro": null,
"text_con": null,
"text_neutral": "Lovely"
},
{
"internal_id": 424,
"code": "roomquality",
"question_titles": [
{
"name": "Rooms quality",
"code": "en"
}
],
"rating": 5,
"text_pro": "Awesome, very confortable",
"text_con": "Would have loved better view",
"text_neutral": null
}
]
}
]
```
{% endcode %}
### Fields available
| Fields | Type | Description |
| -------------- | ------- | ------------------------------------------------------------ |
| configuration | Object | See [Configuration object](#configuration-object) |
| stay | Object | See [Stay object](#stay-object) |
| segment | String | Segment for the stay |
| purpose | String | Purpose for the stay |
| customer | Object | See [Customer object](#customer-object) |
| internal\_id | Numeric | Internal CRM ID for the Satisfaction Survey |
| response\_date | Date | Date of the response to the Satisfaction Survey by the guest |
| average\_score | Numeric | Average score for the survey |
| ratings | Array | See [Ratings Array](#ratings-array) |
#### Configuration object
| Fields | Type | Description |
| -------------- | ------- | ---------------------------------------- |
| business\_name | String | Property name in Experience CRM |
| business\_id | Numeric | Property ID in Experience CRM |
| rating\_min | Numeric | Minimum rating possible for the property |
| rating\_max | Numeric | Maximum rating possible for the property |
#### Stay object
| Fields | Type | Description |
| ------------------------------- | ------- | ------------------------------------------------------------ |
| booked\_at | String | Creation date for the booking |
| arrival\_date | String | Arrival date of the guest |
| arrival\_day | String | Day of arrival |
| departure\_date | String | Departure date of the guest |
| departure\_day | String | Day of departure |
| duration | Numeric | Duration of the stay in days |
| presence\_days | Array | Array of weekdays where the guest is present in the property |
| room\_number | Array | Rooms numbers |
| room\_type | Array | Rooms types |
| rate\_code | String | Rate code |
| booking\_additional\_properties | Array | Additional properties of the booking. |
#### customer object
| Fields | Type | Description |
| -------------------------------- | ------- | ---------------------------------------------------------------------- |
| email | String | Email of the guest |
| title | String | Title of the guest |
| firstname | String | First name of the guest |
| lastname | String | Last name of the guest |
| language | String | Language code |
| birthdate | Date | Birthdate |
| age\_at\_time\_of\_stay | Numeric | Age of the guest at the time of the stay |
| addr\_street | String | Address -street and number |
| addr\_city | String | Address - city |
| addr\_zipcode | String | Address - zip code |
| addr\_country | String | Address - Country code |
| continent | String | Address - Continent |
| nationality | String | Country code for the nationality |
| mobile\_phone | String | Mobile phone |
| phone | String | Phone |
| number\_of\_stays | Numeric | Total count of stay for the guest |
| often\_travel\_to\_city | Boolean | Indicate if the guest is travelling often in the area |
| customer\_custom\_properties | Array | Custom property for the guest in the CRM |
| customer\_additional\_properties | Array | Additional properties for the guest provided by PMS and other sources. |
#### Ratings Array
Each rating in the array is an object matching a question in the Satisfaction Survey.
| Fields | Type | Description |
| ----------------- | ------- | ------------------------------------------------------------------------------------------------------- |
| internal\_id | Numeric | CRM Internal ID for the question/rating |
| deleted\_question | Boolean | Indicate if the question is active or deleted in the CRM |
| code | String | Analytic code for the Question in the CRM |
| question\_titles | Array | Array containing :
- name: the question title
- code: the language code for that question
|
| rating | Numeric | Rating for this question |
| text\_pro | String | Positive comment |
| text\_con | String | Negative comment |
| text\_neutral | String | Neutral comment |
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://experience-crm.gitbook.io/experience-crm-api/reporting/guest-satisfaction.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.