REST API > Get Average Ratings KPI

Through this endpoint you can retrieve KPI statistics for a Location.

Request

Name Method Description
/v1/kpis/average_ratings GET This end-point will retrieve the Average Ratings KPI for a Location.

Request Parameters

Name Data Type Required/Optional Description
api_key string required This is the unique key given to your agency. This key can be found in your agency settings under the White Label API information tile.
location_id integer required/optional This is the unique identifier of a Location in our system. It was automatically created when you created the Location. The location id can be found in the brand settings under the location sign-up form.
client_location_id integer required/optional This is the unique identifier of the Location in your system. This value can be found in the location sign-up form.

Sample Request

GET : https://api.online-review-manager.com/v1/kpis/average_ratings

Response Data

This section outlines the standard response values.

 

How to read the response:

  • The average_ratings->weeks->1 key indicates the average Review Rating for the last week.
  • The average_ratings->weeks->2 key indicates the average Review Rating for the week before last. Etc. The possible keys are:
    • 1
    • 2
    • 3
    • 4
  • The average_ratings->months->1 key indicates the average Review Rating for the last month.
  • The average_ratings->months->2 key indicates the average Review Rating for the month before last. The possible keys are:
    • 1
    • 2

 

Sample Success Response:

{
  "status": "success",
  "message": {
    "average_ratings": {
      "weeks": {
        "1": 5,
        "2": 0,
        "3": 5,
        "4": 4
      },
      "months": {
        "1": 4.8667,
        "2": 4.6522
      }
    }
  }
}