SurveyQuestion

An object describing a survey question.

Field nameTypeConditionsDescription
is_requiredbooleanreadablewritableA flag indicating whether the respondent is required to answer the question. At the moment, all questions are required, so this flag must be set to true.
textstringreadablewritablerequiredmax_length=68Question text
typestringreadablewritablerequired
choices =
  • one_answer - A question that allows selecting only one answer option
  • multiple_answers - A question that allows selecting multiple answer options
  • text_answer - A question with a free-text answer
  • scale_answer - A question with a scale
Question type
answerslist of Answerreadablewritablerequiredmax_items=7List of answer options. For questions with type=text_answer and type=scale_answer, you do not need to specify answer options. For all other types, at least 2 answer options are required. Special answer option types must not be duplicated among the options.
scaleScalereadablewritableScale settings. Must be provided only when type=scale_answer.