Method	Path
GET	https://agora.olery.com/v2/review-summaries/templates/:template_id/generate/:property_id

This route returns the generated Review Summary for a single property. The Summary draws on all available review data to produce a number of text statements about the property.

Output

By default the Summary consists of up to 10 statements, both positive and negative.

Languages

Currently the statements are available in English. Other languages can be made available on demand.

Review Data

For each statement the data point it is based on is provided. It can be used in the implemention alongside the text. These data types are provided:

• review_count
• score (sentiment analysis)
• count of positive opinions
• count if negative opinions

Output Format

Field	Data Types	Description
text	String	Statement text
topic	Array	Topics the statement is about
sentiment	String	Whether the statement is positive or negative
review_count	Integer	Review count this statement is based on
rating	Float	Average rating for this topic
score	Float	Sentiment analysis score
positive_opinions	Integer	Count of positive opinions
negative_opinions	Integer	Count of negative opinions
language	String	Language of the statement

Example Output

(shortened from 10 to 3 statements)

{
  "property_id": "673256",
  "template_name": "Standard (10 most important statements)",
  "data": [
    {
      "any topic 1": {
        "rating": 89.1774809160305,
        "review_count": 1048,
        "sentiment": "positive",
        "topic": [
          "overall"
        ],
        "language": "en",
        "text": "amazing hotel"
      }
    },
    {
      "any topic 2": {
        "review_count": 732,
        "count_delta": 100,
        "language": "en",
        "text": "732 reviews in the past 6 months"
      }
    },
    {
      "any topic 10": {
        "score": 0.703703703703704,
        "review_count": 24,
        "positive_opinions": 23,
        "negative_opinions": 4,
        "sentiment": "positive",
        "topic": [
          "breakfast"
        ],
        "language": "en",
        "text": "nice breakfast"
      }
    }
  ]
}

Parameters

Parameter	Parameter Type	Data Types	Required	Description
property_id	path	Integer	true	The ID of the company.
template_id	path	Integer	true	The ID of the template. Use 1 if not other provided.

Response Statuses

Status Code	Reason
200	OK
404	The specified company was not found.
403	Client does not have access to the company.

Response Fields

Field	Data Types	Description
property_id	Integer	The ID of the company.
template_name	String	The name of the template.
data	Array	The generated data.