Skip to main content

Search

endsurvey

  • Updated

Note: Most of the functionality described in this article is now handled by auto redirect.

The endsurvey widget is used to end interviews. It assigns respondents a final status and can optionally redirect them to a different website.

endsurvey
status: T
redirect: https://www.mypanelcustomredirectpages.com/terminate/

When defining an endsurvey widget you must include either a status or terminate tag. Conditions can be added as needed.

Example

endsurvey
status: <<END
if ($Q1==1) {'C'}
elsif ($Q1==2) {'T'}
END
redirect: <<END
if ($Q1==1) {'https://www.mypanelcustomredirectpages.com/complete/'}
elsif ($Q1==2) {'https://www.mypanelcustomredirectpages.com/terminate/'}
END

Tags

Tag Description
message Displays a custom message to the respondent.
redirect Specifies a web address where the browser should be redirected when a respondent reaches the end of a survey. This tag accepts a text string, a heredoc, and logical statements as input.
set status

Defines a custom respondent status that can be referenced with the status tag. 
status

Specifies the respondent status, using one of the default statuses or a custom status defined with set status. This tag also accepts a heredoc and logical statements.
terminate Accepts 'y'/'n' input. If set to 'y', it marks the respondent status as terminated ('T').

Tip! Setting respondents to status 'I' (Initiated) via the endsurvey widget will place those respondents at the beginning of the survey if they re-enter.

Additional examples

terminate: y

If you are using the endsurvey widget to terminate respondents, you can also use terminate: y, which is the equivalent to set status: T.

start group
condition: anyChecked($QSAMP,1) and (noneChecked($QCOMP_SEL)
endsurvey
terminate: y
redirect: https://www.mypanelcustomredirectpages.com/terminate/

end group

Since the endsurvey widget would be applied to all respondents, a condition tag on a start group is often used to ensure the terminated status is only applied to specific respondents.

Custom status and message

You can create custom statuses with the set status widget and reference them by applying the status tag to the endsurvey widget.

Starting in r9.4, you can also add the message tag to the endsurvey widget to show a custom message to respondents.

set status
V. Attention Checks

1. What color is the sky?
type: radio
1. blue
2. red

start group: ATT_END_SURVEY
condition: anyChecked($Q1,2)

endsurvey
status: V
message: You will not be asked to complete the full survey. Thank you for your time.

end group: ATT_END_SURVEY

... survey continues here

Related to

Related articles

Comments

0 comments

Please sign in to leave a comment.