Matrix Question

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

Matrix Question

{
  "id": "QID1",
  "display": "string",
  "required": "force",
  "type": "matrix",
  "labels": [
    "Strongly Disagree",
    "Disagree",
    "Neutral",
    "Agree",
    "Strongly Agree"
  ],
  "multiSelect": true,
  "statements": [
    {
      "id": "1",
      "display": "string",
      "image": {
        "name": "string",
        "url": "string",
        "textPosition": "top",
        "expandedUrl": "string"
      },
      "textEntry": {
        "contentType": "number",
        "required": true,
        "symbol": {
          "value": "$",
          "position": "before"
        }
      },
      "exclusiveSelect": true
    },
    {
      "id": "string",
      "groupLabel": "string",
      "statements": [
        {
          "id": "1",
          "display": "string",
          "image": {
            "name": "string",
            "url": "string",
            "textPosition": "top",
            "expandedUrl": "string"
          },
          "textEntry": {
            "contentType": "number",
            "required": true,
            "symbol": {
              "value": "$",
              "position": "before"
            }
          },
          "exclusiveSelect": true
        }
      ]
    }
  ],
  "scalePoints": [
    {
      "id": "1",
      "display": "string",
      "image": {
        "name": "string",
        "url": "string",
        "textPosition": "top",
        "expandedUrl": "string"
      },
      "textEntry": {
        "contentType": "number",
        "required": true,
        "symbol": {
          "value": "$",
          "position": "before"
        }
      },
      "exclusiveSelect": true
    }
  ],
  "headers": {}
}