• Register

Lodging - Review Rating Distribution

This endpoint provides rating distribution data for a selected rating type over a given data range.  The available rating types are: 

  • Overall 
  • Service 
  • Cleanliness
  • Location 
  • Value
  • Gastronomy 
  • Room
  • Decoration
  • Business
  • Reception 
  • Entertainment

Excluding the Global Review IndexI™, not all types maybe present for a given lodging/date range combination.  The output value array contains a time series with the following properties:

  • The timestamp: the difference, measured in milliseconds, between the given time and midnight, January 1, 1970 UTC. 
  • The value decimal representation of the score for that given day.

Resource URL

https://connect.reviewpro.com/v1/lodging/review/rating/distribution

Try it now with our interactive API!

Parameters

Param Value Required
api_key <your api key> Yes
pid The product id(s) of the lodging for which data is to be pulled Yes
rt

The rating type requested, maybe one of the following:

  • OVERALL 
  • SERVICE  
  • CLEANLINESS 
  • LOCATION 
  • VALUE 
  • GASTRONOMY 
  • ROOM 
  • DECORATION 
  • BUSINESS 
  • RECEPTION  
  • ENTERTAINMENT

 

 Yes
fd The "from" date for the range of the query. This should be in the format yyyy-MM-dd.  Yes
td The "to" date for the range of the query.  This should be in the fomrat yyyy-MM-dd. Yes

Example GET Request

https://connect.reviewpro.com/lodging/review/rating/distribution?pid=123456&fd=2013-03-05&td=2013-03-08&rt=OVERALL&api_key=<your api key>
[{
    "name": "Hotel ReviewPro",
    "data": {
        "rating_type": "OVERALL",
        "date_range_from": "2012-08-01",
        "date_range_to": "2013-02-01",
        "value": {
            "negative": 0,
            "neutral": 2,
            "positive": 20
        }
    },
    "pid": 123456
}]

version 17 as of 2 years ago by Raymond Koome - ReviewPro