Survey responses with filter

POST https://rest.webropolsurveys.com/api/v1/surveys/{{SurveyId}}/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
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, "Page"=>1}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"SurveyId":"1a4d811b-3386-4c2d-3373-8df43b5a4594","Paging":{"ItemsPerPage":500,"TotalCount":24860,"TotalPages":50,"CurrentPage":50,"IsLastItemFetched":true,"ItemCount":360},"SurveyAnswers":[{"RespondentId":null,"ResponseId":"0725646a-cafb-4126-a4f0-0a6660b9d812","RespondentEmail":null,"ResponseDate":"2020-11-10T11:54:34.253","RespondentAnswers":[{"Keywords":"","QuestionId":"60e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"How likely would you recommend our company? (NPS)","QuestionOptionId":"87e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"22a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Not at all likely - Extremely likely","Answer":"7","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"61e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"What is your favourite city in Finland?","QuestionOptionId":"8de1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"23a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"","Answer":"Helsinki","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"63e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"What is your favourite...","QuestionOptionId":"93e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"24a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"fruit","Answer":"apple","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"63e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"What is your favourite...","QuestionOptionId":"94e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"25a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"drink","Answer":"beer","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"64e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Evaluate our service","QuestionOptionId":"97e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"26a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":null,"Answer":"","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"66e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"What day is your birthday?","QuestionOptionId":"99e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"27a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"DATE","Answer":"10.11.2020","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"69e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Select one or two","QuestionOptionId":"9be1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"28a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":null,"Answer":"APPLE","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"6ce1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"ATTACHMENT","QuestionOptionId":"abe1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"2ea0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Attachment","Answer":"w-logo-blue-bg.jpg","AnswerKeywords":"","AnswerFile":"https://link.webropolsurveys.com/File/GetStoredFile?storedFileId=6c773d3b-6a30-4e52-9b5f-cdb00a6ff549"},{"Keywords":"","QuestionId":"6de1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Please describe in your own words your morivation for applying to this position","QuestionOptionId":"ace1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"2fa0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":null,"Answer":"I am very good at this job.","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"6ae1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Evaluate the car brands 1=poor, 5=excellent","QuestionOptionId":"a3e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"2ca0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Mazda","Answer":"1","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"6ae1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Evaluate the car brands 1=poor, 5=excellent","QuestionOptionId":"a5e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"2da0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Opel","Answer":"2","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"6ae1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Evaluate the car brands 1=poor, 5=excellent","QuestionOptionId":"a1e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"2aa0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Nissan","Answer":"2","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"6ae1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Evaluate the car brands 1=poor, 5=excellent","QuestionOptionId":"a2e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"2ba0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Peugeot","Answer":"2","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"6ae1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Evaluate the car brands 1=poor, 5=excellent","QuestionOptionId":"9fe1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"29a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Renault","Answer":"3","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"70e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Enter your contact details","QuestionOptionId":"bde1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"32a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Last Name","Answer":"Doe","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"70e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Enter your contact details","QuestionOptionId":"bee1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"33a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Email","Answer":"webropoltester+jane@gmail.com","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"70e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Enter your contact details","QuestionOptionId":"c0e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"34a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Telephone","Answer":"12344","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"70e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Enter your contact details","QuestionOptionId":"c2e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"35a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"First Name","Answer":"Jane","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"7ae1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Enter your details","QuestionOptionId":"d1e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"38a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"HEIGHT (CM)","Answer":"174","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"7ae1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Enter your details","QuestionOptionId":"d2e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"39a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"WEIGHT (KG)","Answer":"65","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"7be1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Select your favourite car brands","QuestionOptionId":"d9e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"3aa0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":null,"Answer":"Audi","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"7be1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Select your favourite car brands","QuestionOptionId":"dae1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"3ba0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":null,"Answer":"BMW","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"7ce1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"How's your mood today?","QuestionOptionId":"dfe1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"3ca0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Poor","Answer":"6","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"7de1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Do you like Donald Trump?","QuestionOptionId":"e2e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"3da0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":null,"Answer":"absolutely not","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"7ee1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Select your country and city","QuestionOptionId":"e5e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"3ea0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"","Answer":"STOCKHOLM","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"6fe1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Evaluate the the car brand Volvo","QuestionOptionId":"a69d87e4-7ac8-49a6-9903-2b31b734d355","AnswerOptionId":"30a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Unsafe - Safe","Answer":"2","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"6fe1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"Evaluate the the car brand Volvo","QuestionOptionId":"b8e1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"31a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"Cheap - Expensive","Answer":"2","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"71e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"MULTI SELECTION MATRIX","QuestionOptionId":"cfe1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"37a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"THING B","Answer":"2","AnswerKeywords":"","AnswerFile":null},{"Keywords":"","QuestionId":"71e1e8a2-3823-eb11-a95f-8dd0107f8539","Question":"MULTI SELECTION MATRIX","QuestionOptionId":"cce1e8a2-3823-eb11-a95f-8dd0107f8539","AnswerOptionId":"36a0f7b8-3a23-eb11-a95f-8dd0107f8539","Label":"THING A","Answer":"3","AnswerKeywords":"","AnswerFile":null}]}]}