Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.guidewhale.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Use-cases

Pages inside GuideWhale allow you to tag specific URLs or sections of your application based on URL path matching rules. After a page tag is created, it can be used across GuideWhale for:
  • User Segmentation: show users who have or haven’t visited a page once or multiple times in a specific time period.
  • Content Targeting: target GuideWhale content to users who have or haven’t visited a page once or multiple times in a specific time period.
  • Adoption Milestones: track if user has visited a page as part of an onboarding or adoption milestone.
  • Analytics:
    • Use page in funnel, retention cohort or user path analytics
    • Use page inside an advanced data exploration report
    • Measure page health by analyzing its engagement, adoption and retention metrics.

​
Overview

  • Included URLs: A list of included page rule URL paths.
  • Excluded URLS: A list of pages that should be excluded from included URL rules.
  • Views (30 days): How many times this page has been viewed in the last 30 days.
  • Average View Time (30 days): What the average page view duration was in the last 30 days.
  • Menu:
    • Edit: Open page tag editor.
    • Delete: Delete this page tag.

​
Configuration

  • Core Page:
  • Count Unique Views:
  • Tags:
  • Title:
  • Description:
  • Included Pages:
  • Excluded Pages:

​
URL Path Matching

GuideWhale includes URL matching help and Test URL helpers wherever URL path matching rules are used.
URL Matching Types:
  • URL equals:
  • URL contains:
  • URL starts with:
  • URL ends with:
  • URL matches pattern:
GuideWhale allows you to tag website pages for analytics using flexible patterns:

​
Dynamic URL Paths

  • Wildcards (*): use * to match any sequence of characters in a URL path.
    • e.g. /dashboard/* matches /dashboard/overview, /dashboard/settings, etc.
  • Variables (:variable): use :variable to match dynamic segments.
    • e.g. /user/:userId/profile matches /user/123/profile, /user/abc/profile, etc.

​
URL Structure

A typical web URL is structured as: 
https://domain.com/path/to/page?query=param#fragment
  • Protocol: https://
  • Domain: domain.com
  • Path: /path/to/page
  • Query: ?query=param
  • Fragment: #fragment

​
Untagged URLs

Shows a list of visited URLs within your application environment in the last 7 days that haven’t been tagged yet.
  • Environment: The environment where page view event was captured.
  • Page URL: Full URL path of the visited page.
  • View Count: How many times this page URL has been viewed in the last 7 days.
  • Last Viewed: When this page URL has been last viewed.
  • Tag Page: click this to tag this page with auto-generated recommended page tag rules.