Survey Description Output

Output representation of the response to the Start Survey request.

Property NameTypeDescriptionFilter Group and VersionAvailable Version
errorsString[]Error messages for a failed request.Small, 56.056.0
flowInterview​StateStringState of the flow interview.Small, 56.056.0
invitationIdStringID of the survey invitation that’s related to the request.Small, 56.056.0
isPartially​CmplSurvey​LoadedBooleanIndicates whether a partially completed survey is loaded (true) or a new survey is started (false).Small, 63.063.0
languageCodeStringCode of the language that the survey is created in.Small, 56.056.0
navigation​ActionsStringAvailable navigation actions on the survey page. Possible values are:
  • Back—Go to the previous survey page.
  • Next—Go to the next survey page.
Small, 57.057.0
responseIdStringID of the survey response.Small, 57.057.0
statusStringStatus of the API request. Possible values are:
  • Failure—Survey Response API isn’t successfully run.
  • Success—Survey Response API is successfully run.
Small, 56.056.0
surveyDetailSurvey Detail OutputAll details of the page in the survey.Small, 56.056.0
warningsString[]Warnings for a request.Small, 56.056.0