Skip to main content
Version: v1.0.0


The NumericalResponse interface is used to define the properties of a numerical response. NumericalResponses render as a text input that only accepts numbers, and can optionally have a min and max value, or a placeholder.


"id": "q-numerical",
"prompt": "Numerical example",
"required": true,
"location": "aboveStimulus",
"type": "numerical",
"placeholder": "Enter your age, range from 0 - 120",
"max": 120,
"min": 0



PropertyTypeDescriptionInherited from
hidden?booleanControls whether the response is hidden.BaseResponse.hidden
idstringThe id of the response. This is used to identify the response in the data
location?"sidebar" | "aboveStimulus" | "belowStimulus"Controls the response location. These might be the same for all responses, or differ across responses. Defaults to belowStimulusBaseResponse.location
max?numberThe maximum value that is accepted in the input.-
min?numberThe minimum value that is accepted in the input.-
paramCapture?stringUse to capture querystring parameters in answers such as participant_name. See the examples for how this is used, but prefer uiConfig.urlParticipantIdParam if you are capturing a participant ID.BaseResponse.paramCapture
placeholder?stringThe placeholder text that is displayed in the input.-
promptstringThe prompt that is displayed to the participant. You can use markdown here to render images, links, etc.BaseResponse.prompt
requiredbooleanControls whether the response is required to be answered.BaseResponse.required
requiredLabel?stringYou can provide a required label, which makes it so a participant has to answer with a response that matches label.BaseResponse.requiredLabel
requiredValue?unknownYou can provide a required value, which makes it so a participant has to answer with that value.BaseResponse.requiredValue
secondaryText?stringThe secondary text that is displayed to the participant under the prompt. This does not accept markdown.BaseResponse.secondaryText