SurveyQuestionResult

The survey question result

ResponseResults

ResponseReport for each response of the question


Type Collection of SurveyResponseResult
ResponseAggregate

The aggregates for this question showing Average, NPS and Median for this question taking the respondent filter into account


Id

Id of a survey question.


Type integer
DataLabel

The datalabel of a survey question which can be used to identify a question within a survey.


Type string
Additional info

Must be unique in a survey.

Language

The language which is used to retrieve the Value of a question.


Type string
QuestionTypeId

The id of the question type.


Type integer
Additional info
Caption

The string caption in the requested language


Type string
Required

Indicates if this question is required, respondents must complete this question before they can continue to the next page.


Type boolean
DataTypeId

The datatype of the expected response.


Type integer
Additional info
ScaleTypeId

The scale label type.


Type byte
Additional info
Hidden

Indicates if a question is hidden in a survey.


Type boolean
MinValue

The minimum length of the text, the minimum value of a number.


Type integer
MaxValue

The maximum length of the text, the maximum value of a number.


Type integer
PageNumber

The page number of which the question is shown.


Type integer
OrderNumber

The order of the question within the page or within the parent question.


Type integer
QuestionNumber

The number of the question as it will be shown in the survey.


Type integer
ParentQuestionId

The id of the main question in case this question is a subquestion.


Type integer
UseSentimentScore

Use sentiment score when tagging open responses


Type boolean
SubQuestions

The sub questions of a question.


Type Collection of SurveyQuestion
Additional info

When passing the asFlatList parameter with the 3/surveys/{surveyid}/questions, the subquestions property will be empty and all questions will appear in the root list.

QuestionResponses

Shows the possible responses for this question.


Type Collection of SurveyQuestionResponse
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Related Methods

Retrieve the reults in aggregate for a question by id or datalabel. Hint: If you're looking to get the individual answers to a survey, download the respondents.