| Method | Path |
|---|---|
GET |
https://agora.olery.com/v3/companies/:id/tes |
Returns sentiment opinions stats (as times series and/or grouped by traveler segment)
About TES
The Traveller Experience Score (TES) replaces the Guest Experience Index. The design and rating system of the Sentiment Analysis Technology V2 allows us to provide a Traveller Experience Score combining Sentiment and Numerical Ratings. This is a hospitality first in giving you the insights of both the written reviews and the ratings combined.
Output Format
The meta field contains general information about the property.
The aggregated data is returned as an Array of JSON objects in the
data field. Each object has the following fields:
| Field | Data Types | Description |
|---|---|---|
| date | Date | Start date of each time period, if per parameter is used |
| segment | String | Segment, if segment parameter is used |
| segment_title | String | Segment, if segment parameter is used |
| tes.score | Float | Calculated Traveller Experience Score |
| tes.review_count | Integer | Total number of reviews the calculation was based |
| tes.sentiment | Hash | Underlying Sentiment Rating data for the given topic |
| tes.numerical | Hash | Underlying Numerical Rating data for the given topic |
Parameters
| Parameter | Parameter Type | Data Types | Required | Description |
|---|---|---|---|---|
| id | path | Integer | true | ID of the company |
| start_date | query | Date | true | Start date in ISO 8601 format |
| end_date | query | Date | true | End date in ISO 8601 format |
| per | query | String | false | Date grouping (day, month, quarter, year) |
| segment | query | String | false | Segment grouping (origin-country, composition, language, source) |
| topic | query | String | false | Filter the output by a list of comma-separated topics |
Example Call
https://agora.olery.com/v3/companies/38/tes?start_date=2018-01-01&end_date=2018-03-31&per=month&segment=composition&auth_token=XXX
Example Output
{
"meta": {
"company": {
"id": 38,
"name": "Hotel Casa Amsterdam"
}
},
"data": [
{
"date": null,
"segment": null,
"segment_title": null,
"tes": [
{
"topic": "overall",
"label": "Overall",
"score": 8.827365221949568,
"review_count": 6014,
"sentiment": {
"rating": null,
"review_count": 2570,
"opinions_count": 13648,
"sentiment_score": 8.973152943663461,
"neutral_opinions": 2244,
"negative_opinions": 1943,
"positive_opinions": 9461,
"positive_percentage": 0.8296211855489302
},
"numerical": {
"count": 6014,
"value": 87.65064848686399,
"review_count": 6014
}
},
{
"topic": "facilities",
"label": "Facilities",
"score": 8.913443224863492,
"review_count": 1868,
"sentiment": {
"rating": null,
"review_count": 1868,
"opinions_count": 4789,
"sentiment_score": 8.87900355871886,
"neutral_opinions": 661,
"negative_opinions": 756,
"positive_opinions": 3372,
"positive_percentage": 0.8168604651162791
},
"numerical": {
"count": 243,
"value": 91.78189300411523,
"review_count": 243
}
},
{
"topic": "service",
"label": "Service",
"score": 9.368661596387893,
"review_count": 1258,
"sentiment": {
"rating": null,
"review_count": 1258,
"opinions_count": 1872,
"sentiment_score": 9.493407356002777,
"neutral_opinions": 285,
"negative_opinions": 146,
"positive_opinions": 1441,
"positive_percentage": 0.908002520478891
},
"numerical": {
"count": 583,
"value": 90.9090909090909,
"review_count": 565
}
},
{
"topic": "location",
"label": "Location",
"score": 9.017463539483266,
"review_count": 1189,
"sentiment": {
"rating": null,
"review_count": 1189,
"opinions_count": 1930,
"sentiment_score": 9.098360655737705,
"neutral_opinions": 562,
"negative_opinions": 209,
"positive_opinions": 1159,
"positive_percentage": 0.8472222222222222
},
"numerical": {
"count": 297,
"value": 86.93602693602693,
"review_count": 297
}
},
{
"topic": "fnb",
"label": "Food & Beverages",
"score": 8.941393232190206,
"review_count": 932,
"sentiment": {
"rating": null,
"review_count": 932,
"opinions_count": 1736,
"sentiment_score": 8.971756398940865,
"neutral_opinions": 370,
"negative_opinions": 233,
"positive_opinions": 1133,
"positive_percentage": 0.8294289897510981
},
"numerical": {
"count": 25,
"value": 74.52,
"review_count": 19
}
},
{
"topic": "cleanliness",
"label": "Cleanliness",
"score": 9.128634249974002,
"review_count": 845,
"sentiment": {
"rating": null,
"review_count": 845,
"opinions_count": 1805,
"sentiment_score": 9.17695473251029,
"neutral_opinions": 107,
"negative_opinions": 240,
"positive_opinions": 1458,
"positive_percentage": 0.8586572438162544
},
"numerical": {
"count": 263,
"value": 89.73384030418251,
"review_count": 263
}
},
{
"topic": "value",
"label": "Value",
"score": 7.801000967117988,
"review_count": 523,
"sentiment": {
"rating": null,
"review_count": 523,
"opinions_count": 684,
"sentiment_score": 7.779255319148936,
"neutral_opinions": 141,
"negative_opinions": 167,
"positive_opinions": 376,
"positive_percentage": 0.6924493554327809
},
"numerical": {
"count": 27,
"value": 82.22222222222223,
"review_count": 27
}
},
{
"topic": "ambience",
"label": "Ambience",
"score": 8.60982162045992,
"review_count": 378,
"sentiment": {
"rating": null,
"review_count": 378,
"opinions_count": 489,
"sentiment_score": 8.601823708206688,
"neutral_opinions": 68,
"negative_opinions": 92,
"positive_opinions": 329,
"positive_percentage": 0.7814726840855107
},
"numerical": {
"count": 18,
"value": 87.77777777777777,
"review_count": 18
}
},
{
"topic": "sustainable_travel",
"label": "Sustainable Travel",
"score": 9.2578125,
"review_count": 121,
"sentiment": {
"rating": null,
"review_count": 121,
"opinions_count": 163,
"sentiment_score": 9.2578125,
"neutral_opinions": 16,
"negative_opinions": 19,
"positive_opinions": 128,
"positive_percentage": 0.8707482993197279
},
"ratings": null
},
{
"topic": "sanitary_safety",
"label": "Sanitary Safety",
"score": 3.712121212121212,
"review_count": 109,
"sentiment": {
"rating": null,
"review_count": 109,
"opinions_count": 133,
"sentiment_score": 3.712121212121212,
"neutral_opinions": 18,
"negative_opinions": 66,
"positive_opinions": 49,
"positive_percentage": 0.4260869565217391
},
"ratings": null
},
{
"topic": "health_precautions",
"label": "Pandemic Precautions",
"score": 5.3125,
"review_count": 45,
"sentiment": {
"rating": null,
"review_count": 45,
"opinions_count": 45,
"sentiment_score": 5.3125,
"neutral_opinions": 14,
"negative_opinions": 15,
"positive_opinions": 16,
"positive_percentage": 0.5161290322580645
},
"ratings": null
},
{
"topic": "covid",
"label": "Covid",
"score": 5,
"review_count": 2,
"sentiment": {
"rating": null,
"review_count": 2,
"opinions_count": 2,
"sentiment_score": 5,
"neutral_opinions": 2,
"negative_opinions": 0,
"positive_opinions": 0,
"positive_percentage": null
},
"ratings": null
}
]
}
]
}
Response Statuses
| Status Code | Reason |
|---|---|
| 200 | OK |
| 404 | Company not found |
| 403 | No access, no authentication token |
| 400 | Missing or incorrect dates |