Survey_Get_Info(string key, int surveyId)
Description
Retrieve a survey
| Parameter |
Type |
Required |
Description |
| key |
string |
Yes |
Your API key – used to authenticate your account
|
| surveyId |
string |
Yes |
Return only the survey with the supplied ID
|
| Call (GET) |
| https://api.surveytown.com/2/REST/?method=Survey_Get_Info&key=YOUR_API_KEY&surveyId=1 |
| Possible Response Property Strings |
| Property |
Values |
| type |
survey, event |
| status |
draft, active, complete |
| questionType |
singleText, multiText, singleChoice, multiChoice, matrix, addSum, ranker, snippet, email, subscription, customfield, netPromoter, fileUpload, url, number, date, rating, pictureSingleChoice, pictureMultiChoice |
| inputType |
dropdown, radio |
| radioButtonArrange |
vertical, horizontal |
| shapes |
stars, hearts, users, bells, comments, flags, circles, squares |
| conditionType |
contains, doesNotContain, startsWith, endsWith, isOneOf, isNotOneOf, is, isNot, isGreaterThan, isLessThan, after, before, fileUploaded, fileNotUploaded |
| matchType |
any, all |
| pageAction |
jumpPage, submitSurvey, submitSurveyGoToUrl, goToUrl |
| ipLimitedType |
null, ip, email |
| progressBarPosition |
null, top, bottom, both |
| questionNumbering |
null, page, survey |
| thanksType |
default, message, url |
| Response |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
{ "surveyId": 1, "name": "Customer Survey", "type": "survey", "status": "draft", "surveyURL": "https://s.surveytown.com/survey/?c=5966&id=11", "closedMessage": "The survey you are looking for is CLOSED and is not accepting responses. Thanks for your interest.", "dateLimited": false, "startDate": "0000-00-00 00:00:00", "endDate": "0000-00-00 00:00:00", "title": "", "headerImage": "", "showQuestionNumber": false, "showQuestionNumberType": null, "showProgressBar": false, "progressBarPages": false, "progressBarPercentage": false, "progressBarPosition": null, "showIntro": false, "introText": "", "thanksType": "default", "thanksMessage": "Thanks for taking this survey. Would you like a survey like this one? Come to <a href='http://www.surveytown.com'>SurveyTown</a> and create a great survey.", "thanksUrl": "", "surveyTemplateId": null, "ipLimited": false, "ipLimitedType": null, "purlLimited": false, "responseLimit": null, "sendConfirmationEmail": false, "confirmationEmailSubject": "", "confirmationEmailHtml": "", "sendNotifyEmail": false, "notifyEmailSubject": "", "notifyEmailHtml": "", "urlVariables": [ { "name": "myvar", "label": "myvarlabel", "default": "123" } ], "tags": [ { "tagId": 1, "name": "mytag" } ], "createdDate": "2017-06-03 13:24:36", "updatedDate": "2017-06-04 13:18:50", "pages": [ { "pageId": 15, "displayOrder": 1, "questions": [ { "questionId": 51, "questionType": "singleText", "displayOrder": 1, "questionText": "<p>First Name</p>", "token": "", "isRequired": false, "canDelete": true, "canCopy": true }, { "questionId": 53, "questionType": "singleChoice", "displayOrder": 2, "questionText": "<p>Guest</p>", "token": "", "isRequired": false, "canDelete": true, "canCopy": true, "inputType": "dropdown", "randomOrder": false, "otherChoice": false, "choices": [ { "choiceId": 127, "choiceText": "Yes", "displayOrder": 1 }, { "choiceId": 128, "choiceText": "No", "displayOrder": 2 } ] } ], "logic": [ { "logicId": 3, "conditions": [ { "questionId": 51, "conditionType": "contains", "conditionValue": "bob" }, { "questionId": 51, "conditionType": "endsWith", "conditionValue": "steve" } ], "action": { "matchType": "any", "pageAction": "jumpPage", "submitSurveyGoToUrl": "", "goToUrl": "", "jumpPageId": 16, "sendEmail": false, "emailSubject": "", "emailHtml": "", "emailText": "", "emailToAddress": "", "alertEmailAddress": "" } }, { "logicId": 5, "conditions": [ { "questionId": 53, "conditionType": "isOneOf", "conditionValue": [ "127" ] } ], "action": { "matchType": "any", "pageAction": "jumpPage", "submitSurveyGoToUrl": "", "goToUrl": "", "jumpPageId": 16, "sendEmail": false, "emailSubject": "", "emailHtml": "", "emailText": "", "emailToAddress": "", "alertEmailAddress": "" } } ] }, { "pageId": 16, "displayOrder": 2, "questions": [ { "questionId": 52, "questionType": "singleText", "displayOrder": 1, "questionText": "<p>Source</p>", "token": "", "isRequired": false, "canDelete": true, "canCopy": true }, { "questionId": 54, "questionType": "rating", "displayOrder": 2, "questionText": "<p>Rate Us</p>", "token": "", "isRequired": false, "canDelete": true, "canCopy": true, "steps": 5, "shape": "stars" } ], "logic": [ { "logicId": 4, "conditions": [ { "questionId": 52, "conditionType": "startsWith", "conditionValue": "google" } ], "action": { "matchType": "all", "pageAction": "submitSurvey", "submitSurveyGoToUrl": "", "goToUrl": "", "jumpPageId": 15, "sendEmail": false, "emailSubject": "", "emailHtml": "", "emailText": "", "emailToAddress": "", "alertEmailAddress": "" } } ] } ] } |
|
