Skip to main content

​
1. Install JavaScript SDK

Before you can track user behavior and display GuideWhale content, you need to install our JavaScript SDK in your application.

​
Install GuideWhale Script

To start tracking user behavior and show GuideWhale content, you need to install our code snippet in your application. Steps:
  1. Navigate to Settings > Installation in your dashboard
  2. Copy the provided JavaScript snippet
  3. Add the snippet to your application’s HTML (typically in the <head> or before the closing </body> tag)
  4. Configure user identification to track individual users

​
2. Define Adoption Milestones and User Segments

Understanding your users and their journey is crucial for effective product adoption. This section helps you set up the foundation for tracking and targeting.

​
Tag Your First Page

To easily track page views and use them as adoption milestones, start by tagging your first page. Steps:
  1. Navigate to Data > Pages in your dashboard
  2. Click “Add Page” to create a new page tag
  3. Define the page URL pattern and give it a descriptive name
  4. Save the page tag

​
Tag Your First Feature

To easily track feature usage and use them as adoption milestones, start by tagging your first feature. Steps:
  1. Navigate to Data > Features in your dashboard
  2. Click “Add Feature” to create a new feature tag
  3. Define the feature selector or event trigger
  4. Give it a descriptive name and save

​
Create Adoption Milestones

Now that you’ve tagged your first user events, you can use them to define and start tracking your first adoption milestone. Steps:
  1. Navigate to Milestones in your dashboard
  2. Click “Create Milestone”
  3. Select the events (pages, features) that define this milestone
  4. Configure the milestone criteria and save

​
Create User Segments

To better understand your users and their behavior, create user segments for targeted content delivery. Steps:
  1. Navigate to Users in your dashboard
  2. Click “Create Segment”
  3. Define segment criteria based on user properties, behavior, or milestone completion
  4. Save the segment for use in content targeting

​
3. Create and Publish Engagement Content

This is where you’ll build the interactive guides and tours that help users discover and adopt your product features.

​
Install Chrome Extension

To create and edit GuideWhale content, you first need to install our Chrome extension. Steps:
  1. Click “Install Extension” or visit the Chrome Web Store
  2. Search for “GuideWhale” and click “Add to Chrome”
  3. Confirm the installation
  4. The extension icon will appear in your browser toolbar

​
Create Your First Guide

Try out our builder browser extension and create your first product tour or help guide. Prerequisites: The Chrome extension must be installed Steps:
  1. Navigate to your application in the browser
  2. Click the GuideWhale extension icon
  3. Select “Create New Guide”
  4. Use the visual builder to add steps:
  • Click on elements to highlight them
  • Add tooltips, modals, or hotspots
  • Write helpful content for each step
  1. Preview and save your guide

​
Target Your Guide

Configure who can see your newly created guide and how it should be displayed. Prerequisites: At least one guide must be created Steps:
  1. Open your guide in the dashboard
  2. Navigate to the “Display” tab
  3. Configure targeting options:
  • User Segments: Select which user segments should see this guide
  • Page Targeting: Define on which pages the guide should appear
  • Trigger Conditions: Set when the guide should start (on page load, after delay, on click, etc.)
  1. Save your display settings

​
Publish Your Guide

Your guide will not be visible to your users inside your application until you publish it. Prerequisites: At least one guide must be created Steps:
  1. Open your guide in the dashboard
  2. Review all steps and settings
  3. Click the “Publish” button
  4. Confirm publication
  5. Your guide is now live and visible to targeted users

​
Embed Your Guide (Optional)

Tours & guides can be embedded within your documentation pages or marketing material to help your audience better understand your product. Prerequisites: The guide must be created and published Steps:
  1. Open your published guide in the dashboard
  2. Navigate to the embed settings
  3. Copy the embed code
  4. Paste the code into your documentation or marketing pages
  5. The guide will display as an interactive demo

​
4. Analyze User Behavior and Content Performance

Once your guides are live and users are interacting with your application, you can analyze the data to optimize your product experience.

​
Analyze Adoption Milestones

Understand how your users adopt your product by analyzing milestone completion rates. What you can track:
  • Milestone completion rates over time
  • Time to milestone completion
  • User segments reaching milestones
  • Drop-off points in the user journey

​
Analyze Guide Performance

Analyze how many of your users are starting and completing your guides. Prerequisites: At least one guide must be created Metrics available:
  • Guide start rate
  • Step completion rates
  • Guide completion rate
  • Average time to complete
  • Drop-off analysis by step

​
Define and Analyze Content Goal Contributions

Analyze how successful your content is in helping users reach your goals. Prerequisites: At least one guide must be created What you can measure:
  • Goal conversion rates
  • Content attribution to goals
  • A/B testing results
  • ROI of engagement content

​
Track Application Health

Drill down into individual health metrics to understand where your application is performing well and where it needs improvement. Metrics include:
  • User engagement scores
  • Feature adoption rates
  • Session duration trends
  • User retention metrics

​
Analyze User Behavior

Use funnels and path analytics to better understand how users interact with your application. Analytics tools:
  • Funnel Analysis: Track conversion through multi-step processes
  • Path Analysis: Visualize common user journeys
  • Event Analytics: Deep dive into specific user actions
  • Cohort Analysis: Compare behavior across user groups

​
5. Explore More

​
Integrate with Your Favorite Tools

Start forwarding GuideWhale events to your favorite analytics platforms. Available integrations:
  • Analytics platforms (Google Analytics, Mixpanel, Amplitude, etc.)
  • CRM systems
  • Marketing automation tools
Steps:
  1. Navigate to Settings > Integrations
  2. Select the platform you want to integrate
  3. Follow the configuration instructions
  4. Test the integration
  5. Start receiving GuideWhale events in your connected tools