DOC 425 guides and surveys

app/Tags/GithubEditUrl.php

@@ -13,7 +13,7 @@ class GithubEditUrl extends \Statamic\Tags\Tags
      * @return string|array
      */
 
-    private $endpoint = 'https://github.com/amplitude/amplitude-docs/blob/main/content/';
+    private $endpoint = 'https://github.com/amplitude/amplitude-docs/edit/DOC-425_guides-and-surveys/content/';
 
     public function index()
     {

config/app.php

@@ -17,6 +17,7 @@
     */
 
     'name' => env('APP_NAME', 'Statamic'),
+    'analytics-key' => env('AMPLITUDE_API_KEY'),
 
     /*
     |--------------------------------------------------------------------------

content/collections/analytics/en/microscope.md

@@ -88,4 +88,11 @@ While using Microscope in a supported chart, click on *View User Streams*. Check
 
 In a funnel chart, click into any step after the initial event to enable the **Explore Conversion Drivers** feature. This allows you to explore events triggered **between** funnel steps for converted and dropped-off users.
 
-For more information, see [Amplitude's conversion drivers feature](/docs/analytics/charts/funnel-analysis/funnel-analysis-identify-conversion-drivers).
+For more information, see [Amplitude's conversion drivers feature](/docs/analytics/charts/funnel-analysis/funnel-analysis-identify-conversion-drivers).
+
+## Create a guide or survey from Microscope
+
+On a chart, click a data point to launch microscope. Select *Guide these users* or *Survey these users* to create a guide or survey targeted to that set of users. Amplitude then:
+
+* Creates a cohort based on the chart criteria and data.
+* Creates and launches a new guide or survey, with the cohort added to targeting.

content/collections/guides_and_surveys.yaml

@@ -0,0 +1,22 @@
+title: 'Guides and Surveys'
+sites:
+  - en
+propagate: false
+template: default
+layout: layout
+mount: 8255e7a7-7275-4629-8512-e42b0da92456
+revisions: false
+route: '/guides-and-surveys/{{section}}/{{slug}}'
+sort_dir: asc
+date_behavior:
+  past: public
+  future: private
+preview_targets:
+  -
+    label: Entry
+    url: '{permalink}'
+    refresh: true
+inject:
+  nav_title: guides_and_surveys
+structure:
+  root: false

content/collections/guides_and_surveys/en/analytics-glossary.md

@@ -0,0 +1,189 @@
+---
+id: ba2e2bbb-396d-4f49-9c59-66fab5476120
+blueprint: guides_and_survey
+title: 'Analytics Glossary'
+landing: false
+updated_by: 0c3a318b-936a-4cbd-8fdf-771a90c297f0
+updated_at: 1739222791
+glossary:
+  -
+    id: m6zctaju
+    glossary_section_title: 'Common Guides and Surveys event properties'
+    glossary_section_description: 'All Guides and Surveys events include the following event properties.'
+    glossary_row:
+      -
+        id: m6zctcnn
+        event_name: Key
+        data_type: string
+        event_description: 'A unique identifier for the guide or survey.'
+      -
+        id: m6zd3t6w
+        event_name: 'Is From Debug Mode'
+        data_type: boolean
+        event_description: 'True when the event was sent from preview mode. Use this property to filter administrative activity.'
+      -
+        id: m6zkam1u
+        event_name: 'Lifecycle UUID'
+        data_type: string
+        event_description: |-
+          Enables grouping of Guides and Surveys events by lifecycle.
+          A guide's or survey’s "lifecycle" starts when it is triggered and ends when it is completed or dismissed. Lifecycle is independent of the application sessions.
+
+          Lifecycle UUID is useful for analyzing events for a given guide/survey across multiple app sessions.
+      -
+        id: m6zd4uip
+        event_name: Page
+        data_type: json
+        event_description: 'Details about the page of the guide or survey on which the event occured.'
+      -
+        id: m6zdjd6s
+        event_name: 'Step ID'
+        data_type: number
+        event_description: 'The unique identifier of a guide or survey step.'
+      -
+        id: m6zdjxxu
+        event_name: 'Step Index'
+        data_type: number
+        event_description: "The step's relative zero-based index."
+      -
+        id: m6zdkozf
+        event_name: 'Step Title'
+        data_type: string
+        event_description: 'The title of the step.'
+      -
+        id: m6zdl8nm
+        event_name: 'Is Last Step'
+        data_type: boolean
+        event_description: 'True when the event occured on the last step of a guide or survey. False otherwise.'
+      -
+        id: m6zdm2az
+        event_name: Type
+        data_type: string
+        event_description: '`None` if guide, `Survey` if survey.'
+      -
+        id: m6zdmm45
+        event_name: 'Variant ID'
+        data_type: string
+        event_description: 'A unique identifier for the guide or survey variant. Useful for analyzing guide or survey experiments.'
+      -
+        id: m6zdndpe
+        event_name: Version
+        data_type: number
+        event_description: 'The version identifier for the guide or survey.'
+    type: glossary_set
+    enabled: true
+  -
+    id: m6zdth1m
+    glossary_section_title: 'Generic events'
+    glossary_section_description: 'These events occur for both guides and surveys'
+    event_row:
+      -
+        id: m6zdu2th
+        event_name: Viewed
+        event_description: 'A guide or survey is viewed by a users.'
+        event_specific_properties: |-
+          The json source of the experience. Can be one of:
+          - trigger
+          - SDK
+          - active experience
+          - from experience x, step y
+          - share link
+      -
+        id: m6zdwrsc
+        event_name: 'Tooltip Marker Viewed'
+        event_description: 'The tooltip marker was seen by a user.'
+      -
+        id: m6zdx7xw
+        event_name: Dismissed
+        event_description: 'A user dismissed a guide or survey.'
+      -
+        id: m6zdxj4f
+        event_name: 'Rage closed'
+        event_description: 'The guide or survey was closed within two seconds of appearing.'
+      -
+        id: m6zdxx5e
+        event_name: Completed
+        event_description: |-
+          Indicates a guide or survey is complete, through one of the following:
+
+          1. The user clicks the _Done_ button in a checklist.
+          2. The user clicks the button on the last step with a button.
+          3. On the last step of a pin, the user clicks a button, the target element, or the advance target element.
+          4. On a survey, the user clicks _Complete_.
+          5. On a list or rating survey with no question on the last step, the user selects any option.
+
+          This event doesn't fire on Tooltips.
+    type: event_set
+    enabled: true
+  -
+    id: m6zem80w
+    glossary_section_title: 'Guide-specific events'
+    glossary_section_description: 'Guide-specific events are only relevant to guides.'
+    event_row:
+      -
+        id: m6zemhhp
+        event_name: 'Tooltip Market Viewed'
+        event_description: 'The tooltip marker was seen by a user.'
+    type: event_set
+    enabled: true
+  -
+    id: m6zemxyi
+    glossary_section_title: 'Survey-specific events'
+    glossary_section_description: 'Survey-specific events are only relevant to surveys.'
+    event_row:
+      -
+        id: m6zendv4
+        event_name: 'Survey Submitted'
+        event_description: 'A user submitted a survey response.'
+        event_specific_properties: '`Survey Response` string. The user’s response'
+      -
+        id: m6zeobhf
+        event_name: 'Survey Abandoned'
+        event_description: 'A user dismissed a survey when a response input was not empty.'
+        event_specific_properties: '`Survey Response` string. The user’s draft response'
+    type: event_set
+    enabled: true
+---
+Amplitude prefixes guide-related events with `[Guides-Surveys] Guide` and survey-related events with `[Guides-Surveys] Survey`. 
+
+
+{{glossary}}
+<h2>{{glossary_section_title}}</h2>
+{{glossary_section_description | markdown}}
+{{if glossary_row}}
+<table>
+<thead>
+<th>Property</th>
+<th>Type</th>
+<th>Description</th>
+</thead>
+<tbody>
+{{glossary_row}}
+<tr>
+<td>{{event_name}}</td>
+<td><code class="pr-2">{{data_type}}</code></td>
+<td>{{event_description | markdown}}</td>
+</tr>
+{{/glossary_row}}
+</tbody>
+</table>
+{{/if}}
+{{if event_row}}
+<table>
+<thead>
+<th>Event</th>
+<th>Description</th>
+<th>Properties</th>
+</thead>
+<tbody>
+{{event_row}}
+<tr>
+<td>{{event_name}}</td>
+<td>{{event_description | markdown}}</td>
+<td>{{event_specific_properties | markdown}}</td>
+</tr>
+{{/event_row}}
+</tbody>
+</table>
+{{/if}}
+{{/glossary}}

content/collections/guides_and_surveys/en/analyze-a-survey.md

@@ -0,0 +1,78 @@
+---
+id: 62b666ba-914a-4449-8754-142521b44544
+blueprint: guides_and_survey
+title: 'Analyze a Survey'
+author: 0c3a318b-936a-4cbd-8fdf-771a90c297f0
+updated_by: 0c3a318b-936a-4cbd-8fdf-771a90c297f0
+updated_at: 1738273400
+section: surveys
+landing_blurb: Explore the options available to you as you analyze survey results.
+---
+Amplitude provides you with both high level data in the form of aggregate use and engagement of your surveys, and response level information about individual responses and who left them. This analysis is available in the survey itself.
+
+## Insights tab
+
+A survey's Insights tab contains information to help you understand how your surveys are performing. It tracks responses, identifies trends, and filters data so you can make better decisions based on user feedback.
+
+### Type-specific insights
+
+Some survey types offer insights that are specific to the type of data they capture.
+
+#### NPS
+
+NPS survey questions enable a breakdown of promoters (score: 8 - 10), passives (score: 6,7), and detractors (score: 0 - 5). To calculate the NPS, subtract `% detractors` from `% promoters`.
+
+#### List
+
+See the breakdown of responses by option.
+
+### Filter card
+
+The Filter card enables you to narrow the scope of your analysis to a specific date range, segment, or property condition. For example, look at a users on a specific account tier engaged, or find look at users who performed a specific action.
+
+### Views and completions over time
+
+View line charts for surveys viewed and surveys completed over the time range defined in the filter card.
+
+Use [Microscope](/docs/analytics/microscope) on this chart to dive deeper with session replays, user streams, and session replays. Or target the users in that data point with follow up guides or surveys, create cohort, or download the users for export to another system.
+
+#### Time-based analysis
+
+Track guide and survey engagement trends over predefined time periods.
+
+* Hourly
+* Daily
+* Weekly
+* Monthly
+* Quarterly
+
+With these presets, see when users are most likely to engage with the guide or survey and if engagement changes after, for example, a new product release.
+
+#### Date range selection
+
+Select a predefined range based on the unit of time, or click the calendar icon to define your own range. Choose from:
+
+* Rolling window (`Last # complete days and today`)
+* Since date
+* Between dates
+
+Use the advanced settings to:
+
+* Add a date offset to a rolling window
+* Exclude Today
+* Enable Time Range
+
+## Responses tab
+
+If the Insights tab gives you the big-picture trends, the Responses tab is where you get into the who, what, and when of your survey data.
+
+This is where you’ll read through individual responses to see exactly what users had to say. Instead of just numbers and summaries, you get raw, user-level data, tied to specific users and timestamps.
+
+On the responses tab, you can:
+
+* View individual responses: See exactly what each user submitted.
+* Sort & filter: Organize responses by date, user ID, or specific answers.
+* Pin important columns: Keep key data points visible while scrolling.
+* Adjust date ranges: Look at responses over the past 7, 30, 60, or 90 days.
+
+If you’re trying to figure out why users feel a certain way, this tab gives you the nitty-gritty details to help make sense of their feedback.

content/collections/guides_and_surveys/en/build-a-survey.md

@@ -0,0 +1,57 @@
+---
+id: b321e1a4-7306-48df-a501-f49573d7f897
+blueprint: guides_and_survey
+title: 'Build a Survey'
+author: 0c3a318b-936a-4cbd-8fdf-771a90c297f0
+updated_by: 0c3a318b-936a-4cbd-8fdf-771a90c297f0
+updated_at: 1738273389
+section: surveys
+landing_blurb: See what goes in to building a survey, and how they differ from guides.
+---
+The survey build experience contains many of the same features at the guide builder, and uses a subset of the available [form factors](/docs/guides-and-surveys/guides/form-factors#form-factors) (modal, popover, pin) and [properties](/docs/guides-and-surveys/guides/form-factors#properties).
+
+## Survey blocks
+
+Surveys offer four unique block types, each suitable for capturing a different kind of user feedback.
+
+### Rating
+
+The Rating block enables users provide structured feedback using a scale you define. Surveys provide the following rating types:
+
+| Rating type   | Description                                                                            |
+| ------------- | -------------------------------------------------------------------------------------- |
+| Stars         | A three or five point scale that displays star icons to the user.                      |
+| Rating labels | Enter text labels that appear on the low and high ends of the scale.                   |
+| Emoji         | A two, three, or five point scale that displays emojis that you choose for each value. |
+| NPS           | A 0 - 10 point [Net Promoter Score](https://en.wikipedia.org/wiki/Net_promoter_score). |
+
+Click the gear icon in the rating block to access more settings.
+
+| Setting                 | Description                                                                  |
+| ----------------------- | ---------------------------------------------------------------------------- |
+| Required                | Enable to require the user to enter a rating.                                |
+| Numbers                 | A five or ten point scale that displays numbers to the user.                 |
+| Stars / Numbers / Emoji | Select the number of options available in the rating. Not applicable to NPS. |
+
+#### Conditional logic
+
+Unlike guides, surveys often require dynamic responses based on user input. Conditional logic supports these use cases.
+
+On each step of a survey, you can add one or more conditions that consider the entered rating, and enable you to trigger an action if the rating meets the condition.
+
+Use conditional logic to:
+
+* **Trigger actions based on responses**: Change what happens next depending on how a user answers.
+* **Branch survey paths**: Users who give a low rating might get a follow-up question asking why.
+* **Personalized experiences**: Show different questions or steps based on previous responses.
+
+For example, if you have a question with a five point scale, you can use the following logic:
+
+* If `rating < 4` then `Show step to ask what went wrong`
+* If `rating > 3` then `Show step with a 'thank you' message`
+
+This logic asks a followup question to users who gave a 1-3, and shows a thank you message to users who gave a 4 or 5.
+
+## Setup and target your survey
+
+Setup and targeting of surveys works the same as for [guides](docs/guides-and-surveys/guides/setup-and-target). Follow those instructions for your survey.