Welcome to the Web SDK Alpha! This guide will help you integrate and explore the features of our new Web SDK. Designed to be simple and intuitive, this SDK allows you to start capturing user sessions and data immediately after integration.
Note: This is a closed alpha. We are inviting a small, select group of customers directly. If you are interested in the web SDK, feel free to join the waitlist for the Web Beta Program here.
1. Access to new organization
Once you've accepted to participate in our Web Alpha program, our product team will go ahead and create a new organization for your Web under your company account. You will be able to switch between the mobile and web environments in 1 click.
You can access the new organization and find your app key to integrate your web SDK by :
Click on your name > Wep Alpha organization
Don't forget to invite the rest of your team!
2. Web Integration
It's now time to integrate the Web SDK into your website. Setting this up is easy and takes a few minutes. All you need is your app key which you will find here.
✏️ Note » If you copy and paste the snippet directly from the integration page on the dashboard, your app key will already be included. However, if you're following the tech guides, be sure to replace the placeholder with your app key.
You have two installation methods :
- By code : Copy and paste the snippet of code on your website, preferably below the <head> tag. → Read more on the code installation
- Using google tag manager → Read more on google tag manager here
Once done, you’ll see a confirmation pop-up indicating that the integration is complete.
2. Occlude any elements you don't want to capture
Inputs will be occluded automatically if they meet any of the following criteria. Check out the occlusion guide.
3. Send custom events and properties via code or Google Tag manager
UXCam captures the following events on web automatically. Check out the technical documentation to track custom events.
- uxc_input: Triggered when an input loses focus after it has been modified.
- uxc_submit: Triggered when a form is submitted.
-
uxc_u_turn: Triggered when a user goes back to the same page. The event is triggered on the page they went back to.
Example: If a user navigates Home > About Us > Home, it will be triggered on Home. - uxc_page_refresh: Triggered when refreshing the page.
You can of course analyze these events anywhere in the dashboard.
4. Send user properties or identify your users with a custom user ID.
Unlike mobile devices, users are tracked based on their browser rather than their device. If a user switches browsers, they will be counted as a different user unless an ID is provided.
Below is a table showing the properties shared between mobile and web, as well as those unique to the web. On the web, you’ll find additional details like browser information, referral sources, campaigns, and more.
5. Feedback Collection
Your feedback and participating is crucial for improving our Web SDK. You will be sent an invitation link to a special slack channel with Alpha users where you can ask any questions and share any feedback.
Please make sure you report any bugs or share requests in this portal. You have access to the portal via the dashboard as well.
An end-of-trial interview is required for all program participants. The meeting will be scheduled 1 month after your trial started.
6.What features are available on Web Alpha?
Session Capture and Replay
You will of course be able to watch sessions from your web. However, there are some key differences between web and mobile you should be aware of.
How does UXCam define a web session?
The way we capture sessions on web is different from mobile. A web session starts when a user opens a website tab and starts interacting with it. If there is no incoming data for 3 minutes—due to reasons like the browser/tab being closed, internet loss, or system suspension—the session is considered ended, and the recording is uploaded.
What are some differences between default web vs. mobile properties?
- Filters and Properties: Sessions have filters and properties similar to mobile, though with some differences due to the variations between web and mobile properties. For instance, a Browser filter is available, but a Device model filter is not. Check out some web specific properties.
How are screens captured on web?
- Screen Capture: Screens (or pages) are captured automatically whenever there is a change in the URL path. This means every time a user navigates to a new page or a page with a different URL path, a new screen is recorded. You can read more about how screens are captured.
Users Analytics
The Users Page in UXCam’s Web SDK provides detailed insights into the behavior and characteristics of individual users who interact with your web platform. This page is your go-to resource for understanding how users navigate your site, engage with content, and experience your product.
Events Page
Event List: Track and manage key user actions on your website, such as clicks or form submissions. The Event List shows all defined events, helping you monitor user interactions effectively.
Event Analytics: Analyze these interactions to gain insights into user behavior. See how often events occur, spot patterns, and identify areas for improvement. This data helps you optimize your website's user experience.
Dashboards
Available Reports and Metrics
You can create custom dashboards and reports as usual. However you'll only be able to create reports based on sessions, users, screens, conversion, and events. Issues reports are not yet supported in this alpha version.
- New Grouping Options: Group data by browser, browser version, and other web-specific properties such as UTM parameters to understand the source of traffic (e.g., campaigns from Facebook, Google Ads).
- Filtering: At the moment, screen/page visit filters only allow for ‘equals’ operator. However, if you want more flexibility when analyzing pages, you can use our uxc_url_navigate event that allows you to filter by all pages that contain or do not contain a certain text/name.
Next steps
Now let's get started on some quick wins for the available features.