CurrentSessionPage

The current page of the session.

sessionIdsessionId (string)

The id of the current session.

Possible values: Value must match regular expression FS_[a-zA-Z0-9]+

Example: FS_1234567890

embeddedData object

Any embedded data to set on the survey session.

property name*embeddedDataValue (string)

questions object[]

Array [

oneOf

• mc
• te
• db

questionIdquestionId (string)required

The question id

Possible values: Value must match regular expression QID\d+

Example: QID1

typesupportedQuestionTypes (string)required

The question type

Possible values: [db, mc, te]

displayquestionText (string)required

The question text

Example: Click here to write the question text

choices object[]

Array [

choiceIdmcChoiceId (string)

Possible values: Value must match regular expression \d+

Example: 1

displaychoiceText (string)

Example: Click to write Choice 1

textualisTextual (boolean)

Does this choice allow a text response? Typically used for "Other" type choices

]

options object

columnLabelsstring[]required

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

multiSelectmultiSelect (boolean)required

Distinguish between single answer (false) and multiple answer (true) (radio buttons vs checkbox).

]

responses object

A map of question ids to their response

property name* IdMapping

oneOf

• mcResponse
• teResponse

oneOf

• mcExplicitResponse
• mcFuzzyResponse

object

A mapping of choice ids to their selected value and entered text

done object

oneOf

• endOfSurveyMessage
• isDone

endOfSurveyMessage (string)

Whether the session has been completed. If truthy, it will contain the end of survey message.

CurrentSessionPage

{
  "sessionId": "FS_1234567890",
  "embeddedData": {
    "edKey": "edValue",
    "customerName": "Kyle"
  },
  "questions": [
    {
      "questionId": "QID1",
      "type": "db",
      "display": "Click here to write the question text",
      "choices": [
        {
          "choiceId": "1",
          "display": "Click to write Choice 1",
          "textual": true
        }
      ],
      "options": {
        "columnLabels": [
          "Disagree",
          "Neutral",
          "Agree"
        ],
        "multiSelect": true
      }
    },
    {
      "questionId": "QID1",
      "type": "db",
      "display": "Click here to write the question text",
      "options": {}
    },
    {
      "questionId": "QID1",
      "type": "db",
      "display": "Click here to write the question text",
      "options": {
        "url": "string"
      }
    }
  ],
  "responses": {},
  "done": "string"
}