Get survey options response

meta objectrequired

httpStatusHttp status code (string)required

HTTP status code.

requestIdrequestId (string)required

The unique identifier of the associated request.

noticeAn informational string about the request. (string)

Additional information about this response.

result objectrequired

AnonymizeResponseAnonymizeResponse (string)

Scrub all respondent identifying information such as IP or location data.

Possible values: [No, Yes]

Default value: No

AutofocusAutofocus (boolean)

If true, provide autofocus for questions.

AutoadvanceAutoadvance (boolean)

Enables autoadvance on questions

AutoadvancePagesAutoadvancePages (boolean)

Enables autoadvance on pages. This requires Autoadvance to be anbled as well

AvailableLanguages object

The languages the survey supports.

property name* string[]

Array [

string

]

BackButtonBackButton (boolean)required

If true, display the back button

Default value: false

BallotBoxStuffingPreventionBallotBoxStuffingPrevention (boolean)required

If true, prevent respondents from taking the survey multiple times.

Default value: false

BallotBoxStuffingPreventionBehaviorBallotBoxStuffingPreventionBehavior (string)nullable

Ballot box stuffing prevention behavior.

Possible values: [default, DefaultMessage, DisplayMessage, Redirect, Continue]

Default value: default

BallotBoxStuffingPreventionMessageBallotBoxStuffingPreventionMessage (string)nullable

ID of the library message shown to prevent ballot box stuffing. See BallotBoxStuffingPrevention and BallotBoxStuffingPreventionMessageLibrary.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

BallotBoxStuffingPreventionMessageLibraryBallotBoxStuffingPreventionMessageLibrary (string)

Library ID associated with the Message ID in BallotBoxStuffingPreventionMessage.

Possible values: Value must match regular expression ^(UR|GR)_[a-zA-Z0-9]{11,15}$

Example: UR_SomeUserId001

BallotBoxStuffingPreventionURLBallotBoxStuffingPreventionURL (string)

Ballot Box stuffing prevention URL.

CollectGeoLocationCollectGeoLocation (string)

Collect respondents Geo Location. Default false.

Possible values: [true, false]

Default value: true

CustomStylesobject

Custom CSS to load when survey taking. See also ExternalCSS.

CustomLanguages object

The custom languages the survey supports.

property name* object

DisplayNamestringrequired

Name of the custom language

ErrorMessagesstringrequired

Base language for the custom language

EmailThankYouEmailThankYou (string)

Send an email thank you message after survey completion

Possible values: [true, false]

Default value: false

EOSMessageEnd of Survey Message (string)nullable

ID of the message to be displayed at the end of the survey

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

EOSRedirectURLEOSRedirectURL (string)

The URL to redirect respondents to at the end of the survey used when SurveyTermination is set to Redirect.

ExternalCSSExternalCSS (string)

CSS URL to load when survey taking. See also CustomStyles.

headerMidheaderMid (string)nullable

ID of the library message to display in the header. Do not use in conjunction with Header.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

HeaderHeader (string)required

Header to display on each page such as a logo. Do not use in conjunction with headerMid.

footerMidfooterMid (string)nullable

ID of the library message to display in the footer. Do not use in conjunction with Footer.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

FooterFooter (string)required

Footer to display on each page such as a logo. Do not use in conjunction with footerMid.

InactiveSurveyInactiveSurvey (string)nullable

Whether or not to use a custom validation message. See InactiveMessage and InactiveMessageLibrary.

Possible values: [DefaultMessage, DisplayMessage]

InactiveMessageInactiveMessage (string)nullable

ID of the library message to use when InactiveSurvey is set to DisplayMessage. See InactiveSurvey and InactiveMessageLibrary.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

InactiveMessageLibraryInactiveMessageLibrary (string)

Library ID associated with the Message ID in InactiveMessage.

Possible values: Value must match regular expression ^(UR|GR)_[a-zA-Z0-9]{11,15}$

Example: UR_SomeUserId001

NoIndexNoIndex (string)required

Prevent search engines from indexing the survey.

Possible values: [Yes, No]

Default value: Yes

nextButtonMidnextButtonMid (string)nullable

ID of the library message to display in the "next" button. Do not use in conjunction with NextButton.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

NextButtonNextButton (string)required

The text to use as the "next" Button. Note that BackButton should be enabled for this property to be used. See nextButtonMid and BackButton.

Default value: ←

PageTransitionPageTransition (string)

Transition between page navigation.

Possible values: [None, Slide, Fade, Flip, Barrel]

Default value: None

PartialDataPartialData (string)required

Specify how long a respondent can leave a survey unfinished before that survey automatically closes. A value of No specifies to delete partial completion data. See also PartialDataCloseAfter.

Possible values: [No, +1 hour, +4 hour, +1 day, +2 days, +3 days, +1 week, +2 weeks, +1 month, +3 months, +6 months, +1 year]

Default value: +1 week

PartialDataCloseAfterPartialDataCloseAfter (string)

When the partial data deadline starts, either by LastActivity or SurveyStart. See PartialData.

Possible values: [``, LastActivity, SurveyStart]

PasswordPassword (string)

The password to take the survey. See PasswordProtection.

PasswordProtectionPasswordProtection (string)nullable

Require a password to take the survey. See Password.

Possible values: [No, Yes]

Default value: No

previousButtonMidpreviousButtonMid (string)nullable

ID of the library message to display in the "previous" button. Do not use in conjunction with PreviousButton.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

PreviousButtonPreviousButton (string)required

The text to use as the "previous" Button. Note that BackButton should be enabled for this property to be used. See previousButtonMid and BackButton.

Default value: ←

ProgressBarDisplayProgressBarDisplay (string)required

Shows participants a progress bar.

Possible values: [None, Text, NoText, VerboseText]

Default value: None

QuestionsPerPageQuestionsPerPage (string)

Number of questions to display per page.

Possible values: Value must match regular expression ^[\d]+$

RecaptchaV3RecaptchaV3 (string)

Apply bot detection on the survey taking experience.

Possible values: [true, false]

RefererCheckRefererCheck (string)

Whether or not to restrict the URL respondents must come from to access the survey. See RefererURL.

Possible values: [No, Yes]

Default value: No

RefererURLRefererURL (string)

The URL respondents must come from to access the survey. See RefererCheck.

ResponseSummaryResponseSummary (string)

Shows the response summary at the end of the survey used when SurveyTermination is set to ResponseSummary.

Possible values: [Yes, No]

Default value: No

SaveAndContinueSaveAndContinue (boolean)required

If true, allow respondents to save and continue later.

Default value: true

SecureResponseFilesSecureResponseFiles (string)required

If true, uploaded files by respondents can only be viewed by the survey owner.

Possible values: [true, false]

Default value: true

Skin objectrequired

The skin definition.

oneOf

• string
• object

string

SurveyExpirationSurveyExpiration (string)nullablerequired

Sets the survey to be available during a specified time period. See SurveyStartDate and SurveyExpirationDate.

Possible values: [on, DateRange, None]

Default value: null

SurveyExpirationDatestring<date-time>nullable

When respondents can no longer take the survey.

SurveyMetaDescriptionSurveyMetaDescription (string)

Meta description for the survey, used by search engines and so forth.

Possible values: <= 100 characters

SurveyLanguageSurveyLanguage (string)

The default language of the survey.

Possible values: [AR, ASM, AZ-AZ, BEL, BG, BN, BS, CA, CEB, CH, CS, CY, DA, DE, EL, EN_GB, EN-US, EN, EO, ES-ES, ES, ET, FA, FI, FR-CA, FR, GU, HE, HE-ZA, HI, HIL, HR, HU, HYE, ID, ISL, IT, JA, KAN, KAT, KAZ, KM, KO, LT, LV, MAL, MAR, MK, MN, MS, MY, NL, NO, ORI, PA-IN, PL, PT-BR, PT, RO, RU, SIN, SK, SL, SQI, SR-ME, SR, SV, SW, TA, TEL, TGL, TH, TR, UK, UR, VI, ZH-S, ZH-T]

SurveyNameSurveyName (string)

Name of the survey

Possible values: <= 100 characters

SurveyProtectionSurveyProtection (string)required

Survey is either publicly available or restricted by invitation only

Possible values: [PublicSurvey, ByInvitation, PasswordProtected]

Default value: PublicSurvey

SurveyStartDatestring<date-time>nullable

When respondents can start taking the survey

SurveyTerminationSurveyTermination (string)nullablerequired

End of survey action such as showing respondents a response summary. See EOSMessageLibrary, EOSMessage, ResponseSummary, and EOSRedirectURL.

Possible values: [DefaultMessage, DisplayMessage, DisplayResult, ResponseSummary, Redirect]

Default value: DefaultMessage

SurveyTitleSurveyTitle (string)

Title of the survey, displayed to users on the browser window/tab.

Possible values: <= 100 characters

ThankYouEmailMessageThankYouEmailMessage (string)nullable

ID of the library message to use for the thank you email. See EmailThankYou and ThankYouEmailMessage.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

ThankYouEmailMessageLibraryThankYouEmailMessageLibrary (string)

Library ID associated with the Message ID in ThankYouEmailMessage.

Possible values: Value must match regular expression ^(UR|GR)_[a-zA-Z0-9]{11,15}$

Example: UR_SomeUserId001

ValidateMessageValidateMessage (string)

Whether or not to use a custom validation message. See ValidationMessage and ValidationMessageLibrary.

Possible values: [true, false]

Default value: false

ValidationMessageValidationMessage (string)nullablerequired

ID of the library message to use for the custom validation message. See ValidateMessage and ValidationMessageLibrary.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

ValidationMessageLibraryValidationMessageLibrary (string)

Library ID associated with the Message ID in ValidationMessage.

Possible values: Value must match regular expression ^(UR|GR)_[a-zA-Z0-9]{11,15}$

Example: UR_SomeUserId001

property name*any

Get survey options response

{
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  },
  "result": {
    "AnonymizeResponse": "No",
    "Autofocus": true,
    "Autoadvance": true,
    "AutoadvancePages": true,
    "AvailableLanguages": {},
    "BackButton": false,
    "BallotBoxStuffingPrevention": false,
    "BallotBoxStuffingPreventionBehavior": "default",
    "BallotBoxStuffingPreventionMessage": "MS_abcdefg12345",
    "BallotBoxStuffingPreventionMessageLibrary": "UR_SomeUserId001",
    "BallotBoxStuffingPreventionURL": "string",
    "CollectGeoLocation": "true",
    "CustomStyles": {},
    "CustomLanguages": {},
    "EmailThankYou": "false",
    "EOSMessage": "MS_abcdefg12345",
    "EOSRedirectURL": "string",
    "ExternalCSS": "string",
    "headerMid": "MS_abcdefg12345",
    "Header": "string",
    "footerMid": "MS_abcdefg12345",
    "Footer": "string",
    "InactiveSurvey": "DefaultMessage",
    "InactiveMessage": "MS_abcdefg12345",
    "InactiveMessageLibrary": "UR_SomeUserId001",
    "NoIndex": "Yes",
    "nextButtonMid": "MS_abcdefg12345",
    "NextButton": " ← ",
    "PageTransition": "None",
    "PartialData": "+1 week",
    "PartialDataCloseAfter": "",
    "Password": "string",
    "PasswordProtection": "No",
    "previousButtonMid": "MS_abcdefg12345",
    "PreviousButton": " ← ",
    "ProgressBarDisplay": "None",
    "QuestionsPerPage": "string",
    "RecaptchaV3": "true",
    "RefererCheck": "No",
    "RefererURL": "string",
    "ResponseSummary": "No",
    "SaveAndContinue": true,
    "SecureResponseFiles": "true",
    "Skin": "string",
    "SurveyExpiration": "on",
    "SurveyExpirationDate": "2024-07-29T15:51:28.071Z",
    "SurveyMetaDescription": "string",
    "SurveyLanguage": "AR",
    "SurveyName": "string",
    "SurveyProtection": "PublicSurvey",
    "SurveyStartDate": "2024-07-29T15:51:28.071Z",
    "SurveyTermination": "DefaultMessage",
    "SurveyTitle": "string",
    "ThankYouEmailMessage": "MS_abcdefg12345",
    "ThankYouEmailMessageLibrary": "UR_SomeUserId001",
    "ValidateMessage": "false",
    "ValidationMessage": "MS_abcdefg12345",
    "ValidationMessageLibrary": "UR_SomeUserId001"
  }
}