Question

Union of all supported question types

type

Union of all supported question types

Possible values: [db, form, matrix, mc, nps, ro, slider, te]

db

idstringrequired

Unique question identifier

Example: QID1

displaystringrequired

Question text/HTML content to display

requiredstring

Question requirement level - 'off', 'force' (required), 'request' (optional)

Possible values: [off, force, request]

Example: force

typestringrequired

Descriptive Block question type (display-only text/media)

Possible values: [db]

file object

File/image configuration for display

urlstringrequired

URL of the file/image to display

typestringrequired

Type of file

Possible values: [image, file]

descriptionstringrequired

Alt text or description of the file

form

idstringrequired

Unique question identifier

Example: QID1

displaystringrequired

Question text/HTML content to display

requiredstring

Question requirement level - 'off', 'force' (required), 'request' (optional)

Possible values: [off, force, request]

Example: force

typestringrequired

Form question type (multiple text inputs)

Possible values: [form]

choices object[]

Form fields

Possible values: <= 1000

Array [

idstringrequired

Unique choice identifier

Example: 1

displaystringrequired

Choice text/HTML to display

image object

Image associated with the choice

namestringrequired

Image filename

urlstringrequired

Image URL

textPositionstringrequired

Position of text relative to image

Possible values: [top, left, right, bottom]

expandedUrlstring

URL for expanded/full-size image

textEntry object

Text entry field associated with this choice

contentTypestring

Expected content type

Possible values: [number, date, integer]

requiredboolean

Whether text entry is required when choice is selected

Possible values: [true]

symbol object

Symbol/prefix for text entry fields

valuestringrequired

Symbol to display (e.g., '$', '%')

Example: $

positionstringrequired

Position of symbol relative to input

Possible values: [before, after]

exclusiveSelectboolean

Whether selecting this choice deselects all others

Possible values: [true]

]

matrix

idstringrequired

Unique question identifier

Example: QID1

displaystringrequired

Question text/HTML content to display

requiredstring

Question requirement level - 'off', 'force' (required), 'request' (optional)

Possible values: [off, force, request]

Example: force

typestringrequired

Matrix/Likert question type

Possible values: [matrix]

labelsstring[]required

Labels for matrix rows or columns

Possible values: <= 1000

Example: ["Strongly Disagree","Disagree","Neutral","Agree","Strongly Agree"]

multiSelectbooleanrequired

Whether multiple scale points can be selected per statement

statements object[]

Matrix statements (rows)

Possible values: <= 1000

Array [

oneOf

• Choice
• Statement Group

idstringrequired

Unique choice identifier

Example: 1

displaystringrequired

Choice text/HTML to display

image object

Image associated with the choice

namestringrequired

Image filename

urlstringrequired

Image URL

textPositionstringrequired

Position of text relative to image

Possible values: [top, left, right, bottom]

expandedUrlstring

URL for expanded/full-size image

textEntry object

Text entry field associated with this choice

contentTypestring

Expected content type

Possible values: [number, date, integer]

requiredboolean

Whether text entry is required when choice is selected

Possible values: [true]

symbol object

Symbol/prefix for text entry fields

valuestringrequired

Symbol to display (e.g., '$', '%')

Example: $

positionstringrequired

Position of symbol relative to input

Possible values: [before, after]

exclusiveSelectboolean

Whether selecting this choice deselects all others

Possible values: [true]

]

scalePoints object[]

Scale points (columns)

Possible values: <= 1000

Array [

idstringrequired

Unique choice identifier

Example: 1

displaystringrequired

Choice text/HTML to display

image object

Image associated with the choice

namestringrequired

Image filename

urlstringrequired

Image URL

textPositionstringrequired

Position of text relative to image

Possible values: [top, left, right, bottom]

expandedUrlstring

URL for expanded/full-size image

textEntry object

Text entry field associated with this choice

contentTypestring

Expected content type

Possible values: [number, date, integer]

requiredboolean

Whether text entry is required when choice is selected

Possible values: [true]

symbol object

Symbol/prefix for text entry fields

valuestringrequired

Symbol to display (e.g., '$', '%')

Example: $

positionstringrequired

Position of symbol relative to input

Possible values: [before, after]

exclusiveSelectboolean

Whether selecting this choice deselects all others

Possible values: [true]

]

headers object

Custom headers for profile layout (statementId -> scalePointId -> header text)

property name* object

property name*string

mc

idstringrequired

Unique question identifier

Example: QID1

displaystringrequired

Question text/HTML content to display

requiredstring

Question requirement level - 'off', 'force' (required), 'request' (optional)

Possible values: [off, force, request]

Example: force

typestringrequired

Multiple Choice question type

Possible values: [mc]

multiSelectbooleanrequired

Whether multiple selections are allowed

Example: true

choices object[]

Array of choices or choice groups

Possible values: <= 1000

Array [

oneOf

• Choice
• Choice Group

idstringrequired

Unique choice identifier

Example: 1

displaystringrequired

Choice text/HTML to display

image object

Image associated with the choice

namestringrequired

Image filename

urlstringrequired

Image URL

textPositionstringrequired

Position of text relative to image

Possible values: [top, left, right, bottom]

expandedUrlstring

URL for expanded/full-size image

textEntry object

Text entry field associated with this choice

contentTypestring

Expected content type

Possible values: [number, date, integer]

requiredboolean

Whether text entry is required when choice is selected

Possible values: [true]

symbol object

Symbol/prefix for text entry fields

valuestringrequired

Symbol to display (e.g., '$', '%')

Example: $

positionstringrequired

Position of symbol relative to input

Possible values: [before, after]

exclusiveSelectboolean

Whether selecting this choice deselects all others

Possible values: [true]

]

nps

idstringrequired

Unique question identifier

Example: QID1

displaystringrequired

Question text/HTML content to display

requiredstring

Question requirement level - 'off', 'force' (required), 'request' (optional)

Possible values: [off, force, request]

Example: force

typestringrequired

Net Promoter Score question type

Possible values: [nps]

columnLabelsstring[]required

Labels for the NPS scale (typically 2 labels for 0 and 10)

Possible values: >= 2, <= 2

Example: ["Not at all likely","Extremely likely"]

ro

idstringrequired

Unique question identifier

Example: QID1

displaystringrequired

Question text/HTML content to display

requiredstring

Question requirement level - 'off', 'force' (required), 'request' (optional)

Possible values: [off, force, request]

Example: force

typestringrequired

Rank Order question type

Possible values: [ro]

choices object[]required

Choices to rank

Possible values: <= 1000

Array [

idstringrequired

Unique choice identifier

Example: 1

displaystringrequired

Choice text/HTML to display

image object

Image associated with the choice

namestringrequired

Image filename

urlstringrequired

Image URL

textPositionstringrequired

Position of text relative to image

Possible values: [top, left, right, bottom]

expandedUrlstring

URL for expanded/full-size image

textEntry object

Text entry field associated with this choice

contentTypestring

Expected content type

Possible values: [number, date, integer]

requiredboolean

Whether text entry is required when choice is selected

Possible values: [true]

symbol object

Symbol/prefix for text entry fields

valuestringrequired

Symbol to display (e.g., '$', '%')

Example: $

positionstringrequired

Position of symbol relative to input

Possible values: [before, after]

exclusiveSelectboolean

Whether selecting this choice deselects all others

Possible values: [true]

]

slider

idstringrequired

Unique question identifier

Example: QID1

displaystringrequired

Question text/HTML content to display

requiredstring

Question requirement level - 'off', 'force' (required), 'request' (optional)

Possible values: [off, force, request]

Example: force

typestringrequired

Slider question type

Possible values: [slider]

statements object[]required

Slider statements

Possible values: <= 1000

Array [

idstringrequired

Unique choice identifier

Example: 1

displaystringrequired

Choice text/HTML to display

image object

Image associated with the choice

namestringrequired

Image filename

urlstringrequired

Image URL

textPositionstringrequired

Position of text relative to image

Possible values: [top, left, right, bottom]

expandedUrlstring

URL for expanded/full-size image

textEntry object

Text entry field associated with this choice

contentTypestring

Expected content type

Possible values: [number, date, integer]

requiredboolean

Whether text entry is required when choice is selected

Possible values: [true]

symbol object

Symbol/prefix for text entry fields

valuestringrequired

Symbol to display (e.g., '$', '%')

Example: $

positionstringrequired

Position of symbol relative to input

Possible values: [before, after]

exclusiveSelectboolean

Whether selecting this choice deselects all others

Possible values: [true]

]

minnumber<double>required

Minimum slider value

Example: 0

maxnumber<double>required

Maximum slider value

Example: 100

stepnumber<double>required

Slider step increment

Example: 1

labelsstring[]required

Labels for slider endpoints

Possible values: >= 2, <= 2

Example: ["Not satisfied","Very satisfied"]

notApplicable object

Not applicable option configuration for slider questions

displaystringrequired

Display text for N/A option

te

idstringrequired

Unique question identifier

Example: QID1

displaystringrequired

Question text/HTML content to display

requiredstring

Question requirement level - 'off', 'force' (required), 'request' (optional)

Possible values: [off, force, request]

Example: force

typestringrequired

Text Entry question type

Possible values: [te]

characterLimit object

Character limits for text entry

minnumber<double>

Minimum character count

maxnumber<double>

Maximum character count

Question

{
  "id": "QID1",
  "display": "string",
  "required": "force",
  "type": "db",
  "file": {
    "url": "string",
    "type": "image",
    "description": "string"
  }
}