This chapter covers the core features and capabilities of Survey Engine.
# Run the built-in demo survey
python src/survey_engine.py --demo
# Run a custom survey from JSON
python src/survey_engine.py --run examples/nps_survey.json
# Analyze collected responses
python src/survey_engine.py --analyze examples/nps_survey.jsonFollow this guide to get Survey Engine up and running in your environment.
| Flag | Description |
|---|---|
--run FILE | Run a survey interactively from a JSON definition |
--analyze FILE | Analyze collected responses for a survey |
--responses-dir DIR | Directory containing response JSON files (default: responses/) |
--demo | Run a built-in demo NPS survey |
{
"id": "customer-feedback",
"title": "Customer Feedback Survey",
"description": "Help us improve our product.",
"questions": [
{
"id": "q1",
"text": "How likely are you to recommend us? (0-10)",
"type": "scale",
"required": true,
"minValue": 0,
"maxValue": 10
},
{
"id": "q2",
"text": "What do you like most?",
"type": "single_choice",
"choices": ["Speed", "Simplicity", "Features", "Price"],
"branches": [
{
"value": "Price",
"target": "q4",
"operator": "equals"
}
]
},
{
"id": "q3",
"text": "Any suggestions?",
"type": "long_text",
"required": false,
"help": "Be as specific as you like."
}
]
}| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | Unique question identifier |
text | string | yes | The question text shown to respondents |
type | string | no | Question type (default: text) |
required | bool | no | Whether an answer is required (default: true) |
choices | array | no | Options for single_choice/multiple_choice |
minValue | int | no | Minimum for rating/scale (default: 1) |
maxValue | int | no | Maximum for rating/scale (default: 10) |
branches | array | no | Conditional branching rules |
help | string | no | Help text shown below the question |
| Field | Type | Description |
|---|---|---|
value | string | The answer value that triggers this branch |
target | string | Question ID to jump to |
operator | string | equals, contains, greater_than, less_than |
Get the full Survey Engine and unlock everything.
Get the complete guide with every chapter unlocked, including code samples, diagrams, and best practices.
Access all interactive tools with complete data, all workload profiles, and the full scenario library.
Downloadable source code, configuration files, and working examples from every chapter.
Free updates for life. Every new chapter, tool, and improvement included.