Skip to main content

Reviews

A review of an item - for example, of a restaurant, movie, or store.

Common Actions​

View reviews for a business location​

To view the reviews for a business location make the following request filling in the business location ID and an access token. This example filters the list to the most recent 2 reviews:

curl -X GET 'https://prod.apigateway.co/products/reputation?filter%5BbusinessLocations.id%5D=AG-123456&page%5Blimit%5D=2' \
  -H 'Authorization: Bearer <Access Token with "business" scope>'

That will give you a response similar to:

{
  "links": {
    "first": "https://prod.apigateway.co/products/reputation?filter[businessLocations.id]=AG-123456&page[cursor]=&page[limit]=2",
    "next": "https://prod.apigateway.co/products/reputation?filter[businessLocations.id]=AG-123456&page[cursor]=Mg==&page[limit]=2"
  },
  "data": [
    {
      "type": "businessLocationReviews",
      "id": "RVW-05153123B0664BCDBFB0F4499B525C57",
      "attributes": {
        "headline": "",
        "reviewBody": "Great experience!",
        "reviewRating": "1",
        "review": "Benjamin Gibbert",
        "publishedAt": "2019-12-24T12:00:00Z",
        "url": "",
        "comments": null
      }
    },
    {
      "type": "businessLocationReviews",
      "id": "RVW-045CFF0D3C4A4B26A40B766E0B5588FD",
      "attributes": {
        "headline": "Super friendly and helpful",
        "reviewBody": "Loved the food!",
        "reviewRating": "5",
        "review": "Jon O'Flinigan",
        "publishedAt": "2018-05-21T19:51:54Z",
        "url": "",
        "comments": null
      }
    }
  ]
}

If there are a large number of reviews they will be broken into multiple pages. Notice the links.next in the response. You may make a GET request to that URI with your Authorization header to retrieve the next page of matches.

curl -X GET 'https://prod.apigateway.co/products/reputation?filter%5BbusinessLocations.id%5D=AG-123456&page%5Bcursor%5D=Mg%3D%3D&page%5Blimit%5D=2' \
  -H 'Authorization: Bearer <access token>'