Overview

The reviews endpoint contains all review information related to a business. You can use this endpoint to display data, create reports, send notifications, and more.

607

Reply Pro App uses the Reviews Endpoint to display aggregated reviews to customers

Default Fields

The following fields are used to access review data:

FieldTypeDescription
idintThe ID associated to a review. Every review will have a unique ID.
data_sourceintThe website where the review came from (i.e Facebook, TripAdvisor, etc.). See Data Source Lookup Table.
ratingfloatThe star rating for a specific review.
contentstringIf someone wrote comments in addition to their star rating, this is what they said.
datestringThe date the review was written in isoformat.
reviewer_namestringThe name or username of the reviewer.
permalinkurlThe URL that goes directly to the review on the data source's website.
responsesarrayA list of response objects. (id, content, date)
flaggedbooleanA boolean denoting whether the review has been flagged for reporting.
imagesarrayA list of image objects.
(
str: url,
str: title,
str: image
)

Additional Fields

The following fields are used to access additional review data:

FieldTypeDescription
hiddenbooleanThis is a field used to hide reviews that should not be counted towards analytics, either due to removal from the original source or other reasons.
reviewer_linkurlThe URL to the profile of the reviewer (i.e Jim Smith's Profile on Yelp).
review_imagesurlThe URL to images associated to a specific review (I.e a sweet picture of my awesome burger I posted on my Yelp reviews).
shared_datestringThe date the review was shared via the Reply Pro application in isoformat.

List All Reviews

Use this URL to request all reviews for a specified business. This will return every review the business has ever received - in paginated form.

https://ad1.replypro.io/api/public/accounts/<account_id>/companies/<company_id>/businesses/<business_id>/reviews

Example of returned data:

{
  "next": null,
  "previous": null,
  "results": [
    {
      "content": "",
      "data_source": "1",
      "date": "2017-11-02",
      "id": "895647",
      "permalink": "https://www.google.com/maps/contrib/103815917515548406044/place/ChIJPzzxsrWqr1QRJx0Tm0bnFV0",
      "flagged": false,
      "rating": "5",
      "responses": [
        {
          "content": "Thanks Breean!",
          "date": "2017-11-02",
          "id": "903218"
        }
      ],
      "reviewer_name": "Breean Mckinney"
    },
    {
      "content": "The food is always great here, and it always comes faster than I expect. Ambiance is nice insides, and it is nice to eat on the patio when the weather is accommodating. The only reason I gave it 4 stars instead of 5 is that on more than one occasion, the waitress/waiter has had to come back and let me know they were out of the dish I originally ordered. That may be why the food is so good - a limited supply of fresh ingredients for each dish, but it still is a little disappointing. But it does not stop me coming back!",
      "data_source": "1",
      "date": "2017-11-02",
      "id": "895646",
      "permalink": "https://www.google.com/maps/contrib/117082706466994463109/place/ChIJPzzxsrWqr1QRJx0Tm0bnFV0",
      "flagged": false,
      "rating": "4",
      "responses": [],
      "reviewer_name": "Cor Garcia"
    }
  ]
}

Get a Review

Use this URL to request a single review object:

https://ad1.replypro.io/api/public/accounts/<account_id>/companies/<company_id>/businesses/<business_id>/reviews/<review_id>

Example of returned data:

{
  "next": null,
  "previous": null,
  "results": [
    {
      "content": "",
      "data_source": "1",
      "date": "2017-11-02",
      "id": "895647",
      "permalink": "https://www.google.com/maps/contrib/103815917515548406044/place/ChIJPzzxsrWqr1QRJx0Tm0bnFV0",
      "rating": "5",
      "responses": [
        {
          "content": "Thanks Breean!",
          "date": "2017-11-02",
          "id": "903218"
        }
      ],
      "reviewer_name": "Breean Mckinney"
    }
  ]
}

Get Reviews With Additional Fields

Use this URL to request for reviews with additional fields:

https://ad1.replypro.io/api/public/accounts/<account_id>/companies/<company_id>/businesses/<business_id>/reviews/<review_id>?fields=reviewer_link,permalink

Example of returned data:

{
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "895647",
      "permalink": "https://www.google.com/maps/contrib/103815917515548406044/place/ChIJPzzxsrWqr1QRJx0Tm0bnFV0",
      "responses": [
        {
          "content": "Thanks Breean!",
          "date": "2017-11-02",
          "id": "903218"
        }
      ],
      "reviewer_link": "https://www.google.com/maps/contrib/103815917515548406044/reviews/"
    },
    {
      "id": "895646",
      "permalink": "https://www.google.com/maps/contrib/117082706466994463109/place/ChIJPzzxsrWqr1QRJx0Tm0bnFV0",
      "responses": [],
      "reviewer_link": "https://www.google.com/maps/contrib/117082706466994463109/reviews/"
    }
  ]
}

🚧

Note:

If additional fields are specified, default fields are not provided unless included in the fields parameter.

Update a Review

Use a PUT request to update data on a review object.

https://ad1.replypro.io/api/public/accounts/<account_id>/companies/<company_id>/businesses/<business_id>/reviews/<review_id>
{
  "hidden": True // Set to false to remove the hidden flag.
}
{
  "id": "895647",
  "hidden": True,
  "content": "",
  "data_source": 1,
  "date": "2017-11-20",
  "rating": "5.00",
  "flagged": False,
  "reviewer_name": "Breean Mckinney",
  "permalink": "https://www.google.com/maps/contrib/103815917515548406044/place/ChIJPzzxsrWqr1QRJx0Tm0bnFV0",
  "responses": [
    {
      "content": "Thanks Breean!",
      "date": "2017-11-02",
      "id": "903218"
    }],
  "reviewer_link":
  "https://www.google.com/maps/contrib/103815917515548406044/reviews/"
}

Data Source Lookup Table

You will need to reference the following data source lookup table to properly display the names of each data source:

{
  1: "Google",
  2: "Yelp",
  3: "Yellow Pages",
  4: "Zomato",
  5: "Foursquare",
  6: "Cars.com",
  7: "Facebook",
  8: "Houzz",
  9: "Dealerrater",
  10: "Edmunds",
  11: "Repair Pal",
  12: "Car Gurus",
  13: "Better Business Bureau",
  14: "Priceline",
  15: "Travelocity",
  16: "Orbitz",
  17: "Hotels",
  18: "Trip Advisor",
  19: "Pet Insurance Review",
  20: "Open Table",
  21: "Hotwire",
  22: "Expedia",
  23: "Booking",
  24: "Trust Pilot",
  25: "Twitter",
  26: "Instagram",
  27: "Beer Advocate",
  28: "Rate Beer",
  29: "Amazon",
  30: "JcPenny",
  31: "Home Depot",
  32: "ATG Stores",
  33: "All Modern",
  34: "Overstock",
  35: "Wayfair",
  36: "Rugs USA",
  37: "Incredible Rugs and Decor",
  38: "Buy Area Rugs",
  39: "Walmart",
  40: "Hayneedle",
  41: "Rugs Direct",
  42: "Skytrax",
  43: "Mouthshut",
  44: "Kayak",
  46: "Play Store",
  47: "Health Grades",
  48: "RateMDs",
  49: "Vitals",
  50: "ZocDoc",
  51: "SureCritic",
  52: "Apartment Guide",
  53: "Apartments.com",
  54: "Apartment Ratings",
  55: "HP",
  56: "Best Buy",
  57: "Staples",
  58: "Office Depot",
  59: "Target",
  60: "B&H Photo Video",
  61: "Product Review",
  62: "Jet",
  63: "Indeed",
  64: "truelocal",
  65: "dimmi",
}

Filtering

Looking to filter by specific values in a field? Checkout Filters