Customer Feedback Made Easy
REST API ListSurveys Resource
Overview
The ListSurveys resource returns an array of all surveys tied to your account.
Resource URI
GET https://www.cognotix.com/api/v1/listsurveys
Response Properties
| Property | Description |
|---|---|
| AllowAnonymousViewing | Boolean value that indicates whether responses can be viewed directly via an obfuscated URL without having to be logged into Cognotix (the URL is supplied via the survey notification POST message) |
| AllowMultipleResponses | Boolean value that indicates whether a respondent can submit multiple web responses |
| AllowPhoneResponses | Boolean value that indicates whether phone responses are allowed |
| AllowWebResponses | Boolean value that indicates whether web responses are allowed |
| CreatedOn | Date and time the survey was created, converted to user's local time zone |
| CustomIntro | The text of any custom intro message |
| PhoneResponseCost | The calculated cost of a phone response |
| PhoneVoice | The gender of the telephone voice (M for man, W for woman) |
| Responses | The number of responses received |
| Status | The current survey status (active or inactive) |
| SurveyId | The globally unique identifier (GUID) used as the survey ID |
| SurveyName | The name of the survey |
| TranscribeVoiceResponses | Boolean value that indictes whether telephone voice responses are transcribed |
Sample Response
[
{
"AllowAnonymousViewing":true,
"AllowMultipleResponses":true,
"AllowPhoneResponses":true,
"AllowWebResponses":true,
"CreatedOn":"\/Date(1280802153000-0500)\/",
"CustomIntro":null,
"PhoneResponseCost":0.6,
"PhoneVoice":"M",
"Responses":3,
"Status":"Active",
"SurveyId":"e7325f64-0505-46e2-xxxx-9dc6016044b2",
"SurveyName":"Customer Satisfaction",
"TranscribeVoiceResponses":true
},
{
"AllowAnonymousViewing":true,
"AllowMultipleResponses":true,
"AllowPhoneResponses":true,
"AllowWebResponses":true,
"CreatedOn":"\/Date(1285529773000-0500)\/",
"CustomIntro":null,
"PhoneResponseCost":0.5,
"PhoneVoice":"M",
"Responses":101,
"Status":"Active",
"SurveyId":"c4fe4387-156f-41b4-xxxx-9dfd00f0a9e9",
"SurveyName":"General Feedback",
"TranscribeVoiceResponses":false
}
]