/survey-questions/average/get
Get Business' Survey Result Averages
Parameters
| Name |
Type |
Required |
Example |
Description |
| businessId |
integer |
yes |
6418 |
Business id. |
| 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 |
| aggregateResponse |
integer |
no |
1 |
It will return an array with results of numbered items. |
Request
POST https://app.gatherup.com/api/survey-questions/average/get
[Content-Type: application/json]
{
"businessId": 6418,
"clientId": "627d5e234e1a2f503c9e12262cf313d693575895",
"hash": "b98340caf25c00be59f5bb5405ca8f358edf22c15a4f8527785af047e541f857"
}
Response
{
"title1": "How would you rate waiting time?",
"averageAnswer1": 8,
"answersCount1": 70,
"title2": "How would you rate services?",
"averageAnswer2": 7,
"answersCount2": 58,
"errorCode": 0,
"errorMessage": "Success"
}
Errors
| errorCode |
errorMessage |
| -1 |
Unknown error |
| 1 |
Invalid hash sign |
| 2 |
Invalid clientId |
| 3 |
Server error - please contact support |
| 4 |
Business does not exist |
| 8 |
BusinessId must be specified |