/online-reviews/get


The following API call allows you to get the online reviews left by a customer as raw data.


Parameters

Name Type Required Example Description
businessId integer no 6418 Business id (or multiple comma-separated ids.)
clientId string(40) yes 04f78...9f9f3 Client id is a unique user identifier provided by GatherUp.
from string(YYYY-MM-DD) no 2013-01-23 Received from
hash string(64) yes bd13a40...303f3c5 Hash is a digital request signature. Learn how to generate hash here.
page integer no 1 Page
to string(YYYY-MM-DD) no 2015-01-23 Received to
type string (google | yelp | facebook | googlemaps | tripadvisor | bbb | yellowpages | citysearch | zillow | avvo | foursquare | zomato | apartmentrating | houzz | opentable | yellowpagesca | glassdoor | cars | trustpilot | edmunds | zocdoc | healthgrades | dealerrater | angieslist | creditkarma | googleqa | vitals | homestars | homeadvisor | indeed | merchantcircle | uhaul | hearingtracker | reviewcentre | ratemds | capterra | clutch | apartments | rent | caring | rehab | shopperapproved | rehabs | bedandbreakfast | nursinghomes | weddingwire | solarreviews) no google Review type
aggregateResponse integer no 1 It will return an array with results of numbered items.

Request

{
   "clientId":"80338307b78b8d84c8b4d40e63e235cc312fcebe",
   "from":"2013-01-23",
   "hash":"3b288032e87d12c08c95dc8a96128f19ec1ec207af383328413d18f9e0aaf1fd",
   "page":"1",
   "to":"2015-01-23"
}

Response

{  
   "page":1,
   "pages":1,
   "reviewId1":"973264",
   "reviewType1":"yelp",
   "reviewAuthor1":"Mark B.",
   "reviewTime1":"2016-01-04T00:00:00+01:00",
   "reviewRating1":5,
   "reviewContent1":"Great place",
   "reviewId2":"972444",
   "reviewType2":"google",
   "reviewAuthor2":"Amanda S.",
   "reviewTime2":"2016-01-03T00:00:00+01:00",
   "reviewRating2":5,
   "reviewContent2":"Super",
   "businessId2":"9732",
   "count":2,
   "perPage":500,
   "errorCode":0,
   "errorMessage":"Success"
}

Errors

errorCode errorMessage
-1 Unknown error
1 Invalid hash sign
2 Invalid clientId
3 Server error - please contact support