For the complete documentation index, see llms.txt. This page is also available as Markdown.

Survey Question Object

Survey Question Object

Field
Type
Description

uuid

String

Question UUID.

position

Integer

Order within the survey (ascending).

label

String

The question text shown to subscribers.

required

Boolean

Whether an answer is required.

type

String

text_input, single_select, multi_select, or checkbox.

options

Array

The selectable options. Present only for single_select and multi_select.

stats

Object

Per-option answer distribution. Present only with expand=stats, and only for select questions.

stats (only with expand=stats)

Field
Type
Description

total_answers

Integer

Number of respondents to this question.

distribution

Array

One entry per option, each { "value": <option>, "count": <respondents> }.

Example (single_select, expand=stats)

{
  "uuid": "sqn_9f8e7d6c",
  "position": 1,
  "label": "What best describes your role?",
  "required": true,
  "type": "single_select",
  "options": ["Founder", "Engineer", "Marketer", "Other"],
  "stats": {
    "total_answers": 1800,
    "distribution": [
      { "value": "Founder", "count": 540 },
      { "value": "Engineer", "count": 720 },
      { "value": "Marketer", "count": 360 },
      { "value": "Other", "count": 180 }
    ]
  }
}