Question answers with filter
POST https://rest.webropolsurveys.com/api/v1/surveys/{{SurveyId}}/{{QuestionId}}/responses
This request uses paging. Request returns max 500 responses per page. If you are using loop IsLastItemFetched will tell if the last page is fetched.
Request body can contain filters for response: StartDate, EndDate, RespondentId, ResponseLanguageId, Questions, IncludeEmptyResponses, Name, Login and Page.
NOTE: All key-values (filters) are optional.
If SurveyAnswers array is empty, no responses have been given.
StartDate = Date of first response
EndDate = Date of last response
RespondentId = Responses of specific respondent ResponseLanguageId = Respondents who answered in specific language
Questions = Filter specific option in text questions
IncludeEmptyResponses = False or true (boolean). Include questions that respondents haven't answered
Name = Location or name of WOTT device
Login = Login name used to login to WOTT device
Page = Returns responses from specific page. Default value 1.
Request Body
{"StartDate"=>"2020-03-25T13:27:41.697Z", "EndDate"=>"2021-03-25T13:27:41.697Z", "RespondentId"=>"65077f1g-9y28-08dh-g7oe-06k4c5664d22", "ResponseLanguageId"=>"9FF64FE9-04DA-4471-9F0C-3F2016E71B4F", "Questions"=>[{"QuestionId"=>"00000000-0000-0000-0000-000000000000", "OptionIds"=>["00000000-0000-0000-0000-000000000000"]}], "IncludeEmptyResponses"=>true, "Name"=>"Turku", "Login"=>"abc12345", "Page"=>1}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"SurveyId":"a925ec73-19b4-4f04-b34q-fdfgfb1d5c81","Paging":{"ItemsPerPage":500,"TotalCount":7,"TotalPages":1,"CurrentPage":1,"IsLastItemFetched":true,"ItemCount":7},"SurveyAnswers":[{"RespondentId":"3fe80870-3741-4d7a-b527-04cdca34241d","ResponseId":"4526c77c-b3bc-4197-a4a3-32fa8968a6b9","RespondentEmail":"toni.nieminen@webropol.fi","ResponseLanguageId":null,"ResponseDate":"2023-10-16T14:57:23","Name":"Turku","Login":"Turku_test","RespondentAnswers":[{"Keywords":null,"QuestionId":"718a080d-ead7-4a79-8f8d-fbaba283b17d","QuestionTypeId":"a9b37363-8d47-40a8-ad88-e2fa22a6ada9","QuestionTypeName":"questionType_selection","QuestionTitle":"How are you?","Label":null,"QuestionAnswers":[{"OptionAnswer":"Great","QuestionOptionId":null,"OptionId":"d2b2914d-1659-4988-b0f4-a1ec92c15ee5","AnswerOptionId":"ed9be92c-130a-4653-9482-b09d00c5460c","AttahedTextFieldValue":"","RowText":null,"AnswerFile":null}]}]},{"RespondentId":"3fe3g5h0-3741-4d4a-152g-04cdca34241d","ResponseId":"5bca8e49-19c1-4be8-86d4-8a934tgb2gt1","RespondentEmail":"test_user2@webropol.fi","ResponseLanguageId":null,"ResponseDate":"2023-10-16T14:57:28","Name":"Turku","Login":"Turku_test","RespondentAnswers":[{"Keywords":null,"QuestionId":"718a080d-ead7-4a79-8f8d-fbaba283b17d","QuestionTypeId":"a9b37363-8d47-40a8-ad88-e2fa22a6ada9","QuestionTypeName":"questionType_selection","QuestionTitle":"How are you?","Label":null,"QuestionAnswers":[{"OptionAnswer":"Goody","QuestionOptionId":null,"OptionId":"a4e54dab-f534-4889-b26c-4941dc000d97","AnswerOptionId":"f391e616-aa96-4702-935d-b09d00c5465d","AttahedTextFieldValue":"","RowText":null,"AnswerFile":null}]}]},{"RespondentId":"2fe20271-072f-1e71-bg37-0acdca48601d","ResponseId":"88fe23cd-35b5-43ce-a33f-34fsh2a3s4da","RespondentEmail":"test_user3@webropol.fi","ResponseLanguageId":null,"ResponseDate":"2023-10-16T14:57:53","Name":"Turku","Login":"Turku_test","RespondentAnswers":[{"Keywords":null,"QuestionId":"718a080d-ead7-4a79-8f8d-fbaba283b17d","QuestionTypeId":"a9b37363-8d47-40a8-ad88-e2fa22a6ada9","QuestionTypeName":"questionType_selection","QuestionTitle":"How are you?","Label":null,"QuestionAnswers":[{"OptionAnswer":"Goody","QuestionOptionId":null,"OptionId":"a4e54dab-f534-4889-b26c-4941dc000d97","AnswerOptionId":"6a36de39-d88a-43a1-9000-b09d00c54804","AttahedTextFieldValue":"","RowText":null,"AnswerFile":null}]}]}]}