REST API > Get Reviews

Through this API you can get reviews for the current date or for your selected date range.

Request

Name Method Description
/v1/getreviews GET This end-point will retrieve reviews for a location from the Online Review Manager Portal.

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.
brand_id integer required/optional This is the unique identifier of a Brand in our system. It was automatically created when you created the Brand. The brand id can be found in your account settings under the account information tile.
client_brand_id string required/optional This is the unique identifier of a Brand in your system. This value can be found in the brand sign-up form.
location_id string optional This is the unique identifier of a Location in our system. It was automatically created when you created the Location. If you leave this field blank you will get a list of all Locations. The location id can be found in the brand settings under the location sign-up form.
client_location_id string optional This is the unique identifier of the Location in your system. This value can be found in the location sign-up form.
start_date date(yyyy-mm-dd) optional Search for reviews between the Start Date and End Date.
end_date date(yyyy-mm-dd) optional Search for reviews between the Start Date and End Date.
page integer optional The page number to retrieve. Default: 1
review_count integer optional The number of reviews to retrieve per page. Default: 50
mark_review_retrieve string optional If you want to mark the review as Retrieved, set this to Y, otherwise set it to N. Default: Y
sequence string optional The default sort order. Ascending order (asc) or Descending (desc). The default sort order is (asc)

Sample Request

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

Response Data

You will recieve a success or error message. See sample success message below:

Sample Success Message:

{
  "status": "success",
  "message": {
    "reviews": [
      {
        "review_id": "0000001",
        "review_site": "Google",
        "link": "https://www.google.com",
        "rating": "1",
        "title": "Office Lease Center",
        "message": "rude",
        "reviewer": "Alfonso Soldi",
        "directory_url": "https://www.google.com/search?q=Regus%2520New%2520York%2520New%2520York%2520NY&ludocid=3635205031207267829",
        "review_date": "2015-02-09 11:02:29",
        "client_location_id": "",
        "location_id": "SAU1487123456",
        "location_name": "Location Name",
        "store_id": "Unique Store ID"
      }
    ]
  }
}