REST API > Get Total Reviews KPI

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

Request

Name Method Description
/v1/kpis/total_reviews GET This end-point will retrieve the Total Reviews 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/total_reviews

Response Data

This section outlines the standard response values.

 

How to read the response:

  • The total_reviews->weeks->1 key indicates the total number of reviews for the last week.
  • The total_reviews->weeks->2 key indicates the total number of reviews for the week before last. Etc. The possible keys are:
    • 1
    • 2
    • 3
    • 4
  • The total_reviews->months->1 key indicates the total number of reviews for the last month.
  • The total_reviews->months->2 key indicates the total number of reviews for the month before last. The possible keys are:
    • 1
    • 2

 

Sample Success Response

{
  "status": "success",
  "message": {
    "total_reviews": {
      "weeks": {
        "1": 5,
        "2": 0,
        "3": 7,
        "4": 2
      },
      "months": {
        "1": 15,
        "2": 23
      }
    }
  }
}