REST API > Get Outstanding Reviews KPI

Through this API you can get KPI statistics for a Location in an agency

Request

Name Method Description
/v1/kpis/outstanding_reviews GET This end-point will retrieve the Outstanding Reviews KPI for a Location.

Request Parameters

Name Data Type Required/Optional Description
api_key string required This is the unique key given to you when the Agency was created.
location_id integer required/optional This is the unique identifier of the Location in our system.
client_location_id integer required/optional This is the unique identifier of the Location in your system.

Sample Request

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

Response Data

This section outlines the standard response values from the KPI api

 

How to read the response:

  • The outstanding_reviews->days->2 key indicates the number of outstanding reviews for the last 2 days.
  • The outstanding_reviews->days->7 key indicates the number of outstanding reviews for the last 7 days. Etc. The possible keys are:
    • 2
    • 7
    • 30
  • The outstanding_reviews->review_sites->yelp key indicates the number of outstanding reviews for Yelp. The possible keys are:
    • yelp
    • google
    • facebook
    • other

 

Sample Response

{
  "status": "success",
  "message": {
    "outstanding_reviews": {
      "days": {
        "2": 2,
        "7": 3,
        "30": 10
      },
      "review_sites": {
        "yelp": 0,
        "google": 0,
        "facebook": 1,
        "other": 29
      }
    }
  }
}