Skip to main content
Loading...
Skip to article
  • Qualtrics Platform
    Qualtrics Platform
  • Customer Journey Optimizer
    Customer Journey Optimizer
  • XM Discover
    XM Discover
  • Qualtrics Social Connect
    Qualtrics Social Connect

Session Replay Section


Was this helpful?


This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

The feedback you submit here is used only to help improve this page.

That’s great! Thank you for your feedback!

Thank you for your feedback!


Attention: It is your responsibility to comply with all applicable legal requirements relating to your use of this feature, including, where required under applicable laws, obtaining any consent necessary from website visitors before enabling session recording, masking any personal data or other sensitive data in the recordings, and disclosing your use of Qualtrics in making and storing the recordings. For more information about data security and privacy, see Data Security & Privacy for Digital Experience Analytics.
Attention: Place https://*.qualtrics.com in the Content Security Policy header on your website to ensure sessions are recorded. Sessions will not be recorded if you do not have Qualtrics as an authorized domain.

About the Session Replay Section

Session replay reconstructs how a user experiences your website, allowing you and your team to understand where any user frustration is happening so you can quickly and effectively improve the digital customer experience. You can enable it in the Session Replay section of the Settings tab for your Website Insights project. This section also contains several options you can adjust before enabling.

Qtip: To connect session replay data with survey data, you have to add the fields “Q_SR_ID” & “Q_SR_PlaybackUrl” to your survey flow. See Viewing Digital Experience Analytics Data in a Dashboard for step-by-step instructions.
Qtip: Session replays have a 5 second delay to combat bot traffic on your site. However, you may still see extremely short recordings which are only a few seconds long due to short user interactions being captured after the delay.

Turning on Session Replay

To begin recording sessions on your website you need to enable session replay within the Setup tab within Session replay settings.

Attention: Make sure you’ve tested session replay before you turn it on.
  1. Click the toggle under Session replay on/off.
    button to enable session replay
  2. Save or Apply and activate your changes. See Saving and Applying Changes for more information.
  3. Deploy the code snippet from the Deployment tab of your project.

Recording and Consent

After turning on session replay, you have to decide if sessions will be automatically recorded when the page loads, or if explicit consent is required. Select your preferred option from the dropdown:
options for choosing when recording begins

  • Record after users opt-in: Only record sessions after users provide their consent. This setting is selected by default.
    Attention: API is required for this option. You can also use the API to control which pages to record and when to start and stop the recording. See the Qualtrics API documentation for more information. See Integrating Consent Managers with Digital Experience Analytics for how to integrate with OneTrust, a common consent management provider.
  • Record when the web page loads: Begin recording sessions as soon as the web page loads.

You can also only record on specific pages by choosing on which pages to start, pause, and stop the recording. For more information, see Integrating Consent Managers with Digital Experience Analytics.

Masking

Masking allows you to hide input field data like usernames, addresses, and phone numbers from being seen in session replays. This is an important step to prevent users’ private information from being captured and shown in replays.

Attention: Masking is not retroactive. Once a session has been captured, elements will not be hidden if new masking rules are added.

When setting up masking, you have 3 options:
the different session masking options

  • Mask all content: By default, all text, images, and video will be masked. If desired, you can add CSS selectors for any elements you want to exclude from masking. See the “Elements included in Masking” subsection below for a list of elements that are masked by default.
    the mask all content option with CSS selectors

    Attention: If you want to prevent collecting unnecessary PII, choose this option. You can then selectively unmask any elements you are interested in. Any changes made to your website, including new elements added, may not be masked with this option. Always test your settings before publishing and after making changes to your website.
  • Choose what to mask: By default, all text entered into input fields will be masked. If desired, you can remove input field masking by disabling the Mask all input fields Additionally, you can add CSS selectors for any specific elements you want to mask.
    choosing what to mask and adding CSS selectors

    Attention: Since this option by default only masks input fields, some PII may not be masked if it is included on the page directly. Examples of this include an email address on the page as plain text and PII displayed in any profile boxes.
  • No masking: All content in user sessions, except for password fields, will be captured and shown in replays.
    choosing to use no masking

    Attention: If you select this option, all PII except for passwords will be visible in replays.

Elements included in Masking

When you select Mask all content, the following elements will be masked from your session replays:

  • HTML Tags: img, svg, video, object, picture, embed, map, audio
  • All inputs types
    Attention: Placeholder helper text displayed in input fields and background images that are part of the “style sheets” will not get masked, but you can hide them with CSS selectors.
  • All text

Test Sessions

Attention: You must enable 3rd party cookies in your browser to use test sessions.

Testing allows you to see how session replay will work with your latest saved changes. Before you can begin testing you will have to deploy the code snippet on your website.

  1. Select the session replay settings you want to test. You do not need to turn on session replay to run test sessions.
    Qtip: Recording and Consent and Sampling settings do not apply to test sessions.
  2. Click Save.
    section for testing session replay
  3. Within the Setup tab, scroll down to the Testing section.
  4. Select Test session replay. This adds the test session cookie to your browser.
  5. Navigate to your website to record a test session.
  6. A test session banner should appear on your website. Click Start recording to begin a new session.
    start recording option on your website
  7. Test your website, including clicking around, interacting with elements, and performing frustration behaviors.
  8. When you are done with your session, click Stop and exit recording to stop recording and end the session.
    button to stop and exit test session recording
  9. When you’re done testing, click Exit testing.
  10. Navigate to the Session Replay tab of your Website / App Insights project.
  11. Confirm there are sessions appearing in the session replay table. It may take several minutes for new sessions to appear.

Sampling

Sampling allows you to only record a percentage of sessions. By default all sessions will be recorded. To enable sampling, select a sample rate from 1-100 to determine the percentage of sessions that will be recorded.

sampling rate options

Page Groups

Page groups are a collection of individual URLs that fall into 1 page type, such as the individual pages that make up a home page or checkout experience on a website. You can create page groups within the Page groups tab of session replay settings. This allows you to collect insights on a particular part of the digital experience for use in a dashboard.

Qtip: You can add a maximum of 10 page groups within each Website / App Insights project.
Attention: A minimum of 1 page group is required to get digital opportunities insights in dashboards.

Adding a Page Group

  1. Click Add page group.
    "add page group" button
  2. Name your page group.
    configuring page group details
  3. Select a condition for URLs that will be included in the page group.
    • Contains: Include URLs that contain a specific value.
    • Ends with: Include URLs that end with a specific value.
    • Regular expression: A sequence of symbols and characters expressing a string or pattern to be searched for within a URL. For more information on regex, see RegexOne’s documentation.
      Attention: Custom coding features are provided as-is and require programming knowledge to implement. Qualtrics Support does not offer assistance or consultation on custom coding. You can always try asking our community of dedicated users instead. If you’d like to know more about our custom coding services, please contact your Qualtrics Account Executive.
    • Starts with: Include URLs that start with a specific value.
  4. Enter a value for your condition. All URLs that meet the conditions for this value will be included in the page group.
  5. Click Confirm.

Once you’ve created a page group, you can click the 3 horizontal dots to the right of it and select Rename or Delete the group. You can also select Add page group to add an additional group.

Editing or Deleting Page Groups

If you edit or delete a page group, it will be kept in existing sessions that have already been captured. New sessions will reflect the updated change(s).

Multiple Page Groups

If you have multiple page groups, the order of each group matters. If a URL matches the conditions for multiple page groups, it will be added to the group that was created first. Make sure to create your groups in your desired order.

Visitor Details

Visitor details are additional static information you want to capture about website visitors, such as IP address or demographic info. Details are captured at the beginning of a session and don’t involve visitor interactions on your site. You can add visitor details within the Visitor details tab of session replay settings.

Qtip: You can add a maximum of 30 visitor details within each Website / App Insights project.

Adding Visitor Details

Attention: Make sure any visitor details you add are available on your website before the code snippet runs.
  1. Click Add visitor detail.
    button to add a visitor detail
  2. Name your visitor detail.
    configuring visitor details
  3. Select a data type.
    • Static: The value for the visitor detail is manually entered and will not change across sessions or users.
    • Value from Cookie: The value for this visitor detail comes from a website cookie.
    • Value from Javascript: The value for this visitor detail is coming from JavaScript code.
    • IP Address: The value for this visitor detail is your customer’s IP address. This field is set automatically so you don’t have to provide a value.
      Attention: IP addresses are not masked or anonymized.
  4. Enter a value for the visitor detail.
    • Static: Enter the exact value that will be visible in the session recording.
    • Value from Cookie: Enter the name of the cookie that will be searched for on the page.
    • Value from Javascript: Enter the JS expression that will be searched for on the page.
    • IP Address: This is set automatically and you don’t need to set a value.
  5. Click Confirm.
  6. Repeat these steps to add more visitor details if desired. Make sure to save or apply changes when you are done adding visitor details.

Once you’ve created a visitor detail, you can click the 3 horizontal dots to the right and Rename or Delete the detail.

Marking Details as Priority

After adding visitor details, you can mark up to 5 visitor details as priority to display those details when viewing session replays.

Click the star next to each visitor detail you want to mark as a priority. Make sure to save or apply changes when you’re done to save your edits.

marking visitor details as priority

Custom Events

Custom events capture the number of times a visitor interacts on your website for specific web events that you want to track, such as adding an item to a cart, clicking a link, or completing a purchase. These events allow you to gather data on how visitors are engaging, or not engaging, with your website to further enrich your session replay data. Unlike visitor details, this information is not static. You can add custom events within the Custom events tab of session replay settings.

Adding a Custom Event

  1. Click Add custom event.
    button to add a custom event
  2. Name your custom event.
    configuring a custom event
  3. If desired, select Mark as conversion. Conversions are when a user completes a desired action on your website, like making a purchase, signing up for email, or any other event important to your business.
    Attention: You must mark at least 1 event as a conversion to create a digital opportunities widget in your dashboard.
  4. Enter an Event key. This is the name of the event Qualtrics will look for on your website.
    Qtip: Verify your event key with your development team to ensure they are correct.
  5. Click Confirm.
  6. Repeat these steps to add more custom events if desired. Make sure to save or apply changes when you are done adding custom events.
Attention: Your development team will need to add the tracking tag name and tracking code tag ID to your website. These should match the event name and event key you entered within Qualtrics.
Attention: Once you’ve defined your event, you will need to trigger, or “emit,” that event on your website. There are a variety of ways to do so; see Triggering Custom Events for Session Replay.

Conversions

Marking a custom event as a conversion lets you track if your users converted during their visit to your website. This allows you to get insights about the business impact of problems on your website, by quantifying the potential revenue that can be recovered by resolving frustrating user experiences.

Saving and Applying Changes

When you make changes to any session replay settings, these changes must be saved or applied before navigating anywhere else within your project or account. If you leave the page without saving or applying your changes, all new changes will be undone.

buttons to save and apply changes to settings

To save changes you’ve made, click Save. This will save your configuration and allow you to use it in testing, but your changes won’t be applied to session replays or any dashboards using session replay data.

To apply changes you’ve made to session replays and any dashboards using session replay data, click Apply and activate.

Qtip: It may take several hours for dashboards to reflect these changes.

FAQs