Skip to main content
Version: iOS SDK

Start survey programmatically

How to start a survey programmatically?​

In most cases, you should let the Screeb targeting engine start the survey. But sometimes, you may want to run a survey on user action.

Screeb.startSurvey(
    surveyId = "<SURVEY_ID>"
)

Prevent multiple displays?​

If current user already replied to your survey and you would rather not display it many times, please add the allowMultipleResponses argument:

Screeb.startSurvey(
    surveyId = "<SURVEY_ID>",
    allowMultipleResponses = false
)

Respect survey status?​

By default, using manual survey start will ignore the survey status. If you want to respect the survey status, you can add the ignoreSurveyStatus argument and set it to false:

Screeb.startSurvey(
    surveyId = "<SURVEY_ID>",
    ignoreSurveyStatus = false
)

Contextualize response​

The startSurvey command accepts a list of hidden fields. Values passed as parameters will be listed alongside the responses, on the Screeb platform.

Screeb.startSurvey(
    surveyId = "<SURVEY_ID>",
    hiddenFields: [
      “iosHidden1": AnyEncodable(“hiddenField1”),
      “iosHiddenCount”: AnyEncodable(75)
    ]
)