Customer Feedback Made Easy
REST API ListResponses Resource
Overview
The ListResponses resource returns an array of all responses to a survey specified by a supplied survey ID GUID.
Resource URI
GET https://www.cognotix.com/api/v1/listresponses/{SurveyId}
Response Properties
| Property | Description |
|---|---|
| AnonymousUrl | Obfuscated URL used to access the response without being logged into Cognotix (the survey must have "allow anonymous viewing" set to true for this URL to work) |
| ResponseCID | Caller ID value of inbound call (if a phone response) |
| ResponseCreatedOn | Date and time of the survey response, converted to user's local time zone |
| ResponseIP | Respondent's IP address (if a web response) |
| ResponseId | The globally unique identifier (GUID) used as the response ID |
| ResponseMethod | The method of response (phone or web) |
| SurveyId | The globally unique identifier (GUID) used as the survey ID |
| SurveyName | The name of the survey |
| Responses | An array of the actual response value objects (see the following table for details) |
Survey Response Value Properties
| Property | Description |
|---|---|
| FieldDataType | The type of data captured in the response field |
| FieldName | The question label (or specialized label for transcription, voice recording or other converted data values) |
| FieldValue | The respondent's answer (or specialized value for transcription, recording, etc.) |
Sample Response
[
{
"AnonymousUrl":"http:\/\/www.cognotix.com\/surveydisplay\/viewer\/1b85543bfb84cb38910e894851f6xxxx",
"ResponseCID":"",
"ResponseCreatedOn":"\/Date(1291223264000-0600)\/",
"ResponseIP":"127.0.0.1",
"ResponseId":"47cc7240-2033-48fd-xxx-9e3f00b76639",
"ResponseMethod":"Web",
"Responses":[
{
"FieldDataType":"String",
"FieldName":"What is your name?",
"FieldValue":"John Doe"
},
{
"FieldDataType":"String",
"FieldName":"What is your favorite color?",
"FieldValue":"Orange"
}
],
"SurveyId":"c4fe4387-156f-41b4-xxxx-9dfd00f0a9e9",
"SurveyName":"General Feedback"
}
]