The following API call allows you to get the feedback left by a customer as raw data. This is ideal if you would like complete control over styling the feedback and wish to apply your own Schema Markup.
Alternative #1) You can use our /widget/get-html API, which includes styling and markup. Alternative #2) You can use our JSON Endpoint for raw reviews and response data feed.
| 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. |
| hash | string(64) | yes | bd13a40...303f3c5 | Hash is a digital request signature. Learn how to generate hash here. |
| from | string(YYYY-MM-DD) | no | 2013-01-23 | Received from |
| to | string(YYYY-MM-DD) | no | 2015-01-23 | Received to |
| page | integer | no | 1 | Page |
| aggregateResponse | integer | no | 1 | It will return an array with results of numbered items. |
| minRecommend | integer | no | 4 | Minimal recommend |
| maxRecommend | integer | no | 9 | Maximal recommend |
| showSurvey | integer | no | 1 | Include Survey Question results |
| customerId | integer | no | 73463301 | Return feedbacks only for a specific customer |
| visible | integer(0,1) | no | 1 | Return feedbacks visible or not |
{
"clientId":"80338307b78b8d84c8b4d40e63e235cc312fcebe",
"from":"2013-01-23",
"hash":"3b288032e87d12c08c95dc8a96128f19ec1ec207af383328413d18f9e0aaf1fd",
"page":"1",
"to":"2015-01-23"
}
{
"page": 1,
"pages": 1,
"rating1": 5, // [1-5]
"recommend1": 10, // [0-10]
"businessId1": "376",
"feedbackId1": "1",
"dateOfReview1": "2014-12-18T13:45:07+01:00",
"showReview1": "1",
"authorEmail1": "demo@app.gatherup.com",
"authorName1": "John Smith",
"body1": "Example review",
"rating1": 4, // [1-5]
"recommend1": 8, // [0-10]
"jobId1": "12345", // Job id, if exists
"customId1": "12345", // Custom id, if exists
"tags1": "tag1,tag2,tag3", //tags, if exists
"userResponse1": "Thank you!",
"userResponseTime1": "2014-10-16T14:45:07+01:00",
"negativeDetails1": "Negative Details", //negative details, if exists
"businessId2": "1",
"feedbackId1": "2",
"dateOfReview2": "2014-10-16T13:45:07+01:00",
"showReview2": "1",
"authorEmail2": "demo2@app.gatherup.com",
"authorName2": "Frank Smith",
"body2": "Example review 2",
"count": 1,
"perPage": 500,
"errorCode": 0,
"errorMessage": "Success"
}
| errorCode | errorMessage |
|---|---|
| -1 | Unknown error |
| 1 | Invalid hash sign |
| 2 | Invalid clientId |
| 3 | Server error - please contact support |