Filtering Responses
Content Outline
Finding the needle in the haystack, especially a big hay stack requires fine grained filter control, and this is provided by the API so business users can narrow data sets to exactly what they require than retrieve the entire haystack to find it themselves.
- Match for responses collected at location(like downtown only)
- Match for responses collected at after or before dates, or after a certain time of day or before(like evening in downtown)
- Match responses collected during a specific day of week(like sunday evenings in downtown)
- Match for responses collected that contains a specific answer(like sunday evenings in downtown responses from first time visitors who answered yes to their first visit question)
| Parameter | Description |
|---|---|
| location | Array of String Of Locations |
| afterdate | DateTime after which the response was collected, ISO-8601 format (YYYY-MMDDTHH:mm:ss.sssZ) |
| beforedate | DateTime before which the response was collected, ISO-8601 format (YYYY-MMDDTHH:mm:ss.sssZ) |
| filterquestions | Match responses that contain a specific answer, array of responses matches, similar to conditional question matching |
| archived | Match archived(true) or normal(false) |
| days | Match responses collected during specific days of week, Array of Number(Monday = 1, Sunday = 6) |
| aftertime | Time of Day after which the response was collected, ISO-8601 format(YYYY-MMDDTHH:mm:ss.sssZ) |
| beforetime | Time of Day before which the response was collected, ISO-8601 format(YYYY-MMDDTHH:mm:ss.sssZ) |
Responses can be retrieved from API by posting a filter specification for matches to be performed.
Example call to fetch filtered responses
POST https://api.getcloudcherry.com/api/answers
Content-Type: application/json
Example Body
{
"location": [ “Downtown” ],
"afterdate": "2014-06-10T07:00:00.000Z",
"beforedate": "2014-07-10T06:59:59.999Z",
"filterquestions": [],
"archived": false,
"days": [1, 2, 3, 4, 5],
"aftertime": "2014-07-09T22:12:03.140Z",
"beforetime": null
}Example Filtered Response
Array of Response Containing Answers
[{
"id": "52c7d3437c1e0c12ac50e538",
"user": "demo",
"locationId": "Downtown",
"responseDateTime": "2013-12-30T09:24:19.839Z",
"responses": [
{
"questionId": "53621e417c1e0c0ad41ce051",
"questionText": "How would you rate our staffs",
"textInput": "Superheros",
"numberInput": 0,
},
]
},
},..]