Skip to content

Commit 68a9e12

Browse files
inkeep[bot]adboio
andauthored
docs: Add survey abandoned event to Surveys documentation (#15306)
* Add `survey abandoned` event to survey lifecycle events docs * docs: add `survey abandoned` event to JS SDK survey events documentation * docs: add survey abandoned event to partial survey responses section * docs: add survey abandoned event to viewing results event list * revert: remove survey abandoned additions from implementing-custom-surveys.mdx * revert: remove survey abandoned additions from JS SDK usage docs * Apply suggestions from code review --------- Co-authored-by: inkeep[bot] <257615677+inkeep[bot]@users.noreply.github.com> Co-authored-by: Adam Bowker <adam.b@posthog.com>
1 parent 2441a17 commit 68a9e12

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

contents/docs/surveys/creating-surveys.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,3 +399,8 @@ All `survey sent` events triggered during a single user's attempt to complete a
399399

400400
**Billing for partial responses:**
401401
We charge based on unique survey submissions, not individual `survey sent` events. Therefore, you are charged only once per unique `$survey_submission_id`. For example, if your survey has 5 questions and a user answers 3 of them (triggering multiple `survey sent` events with `$survey_completed: false`), you will still be charged for only one survey response, as all those events will share the same `$survey_submission_id`.
402+
403+
**The `survey abandoned` event:**
404+
When a user answers at least one question but navigates away or closes the page before completing all questions, PostHog automatically captures a `survey abandoned` event. This event includes the `$survey_id` property identifying the survey. It's different from `survey dismissed`, which fires when a user explicitly closes the survey without answering.
405+
406+
You can use the `survey abandoned` event in [insights](/docs/surveys/viewing-results#2-creating-your-own-insights) to measure drop-off rates and identify which surveys users start but don't finish.

contents/docs/surveys/viewing-results.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,12 @@ For rating questions (including NPS), the trend charts include an **Open as new
4242

4343
To create insights from survey results, navigate to the [insights tab](https://app.posthog.com/insights) and click on `New insights` button.
4444

45-
There are 3 survey-related events you create insights from:
45+
There are four survey-related events you can create insights from:
4646

47-
1. `survey dismissed`
48-
2. `survey shown`
49-
3. `survey sent` (for responses)
47+
1. `survey shown` - fires when a survey is displayed to a user
48+
2. `survey sent` - fires when a user responds to a question
49+
3. `survey dismissed` - fires when a user explicitly closes the survey
50+
4. `survey abandoned` - (for surveys with partial completion enabled) fires when a user navigates away from the page before completing the survey
5051

5152
When creating an insight, select any of these events. To see data for a specific survey, create a filter using the `Survey ID` or `Survey Name` properties.
5253

0 commit comments

Comments
 (0)