references/examples.md
Minimal survey drafts
These inputs use posthog:survey-create and omit start_date so they stay drafts.
Adapt the questions to the request. Verify any event names and audience rules
against the project before adding them.
In-app NPS
{
"name": "Product recommendation feedback",
"type": "popover",
"enable_partial_responses": true,
"questions": [
{
"type": "rating",
"question": "How likely are you to recommend this product?",
"display": "number",
"scale": 10
},
{
"type": "open",
"question": "What is the main reason for your score?",
"optional": true
}
]
}
This has no audience restriction. Add the user's intended display conditions and targeting before launch.
In-app CSAT after an action
{
"name": "Export satisfaction",
"type": "popover",
"enable_partial_responses": true,
"questions": [
{
"type": "rating",
"question": "How satisfied are you with this export?",
"display": "emoji",
"scale": 5
},
{
"type": "open",
"question": "What would make it better?",
"optional": true
}
],
"conditions": {
"events": { "values": [{ "name": "export_completed" }] }
}
}
Replace export_completed with an event the project already captures at that
moment. The survey shows only after the event fires, which is when the person
can answer.
Hosted feedback form
{
"name": "Product feedback form",
"type": "external_survey",
"questions": [
{
"type": "open",
"question": "What could make this product easier to use?"
}
]
}
Hosted forms do not need a URL display condition, cohort, or linked feature flag. Only enable iframe embedding when requested.
Headless feedback form
{
"name": "In-app feedback definition",
"type": "api",
"questions": [
{
"type": "open",
"question": "What would you like us to improve?"
}
]
}
The application must render this form and capture the survey's events. Use the returned survey and question IDs in that implementation; do not invent them.