Help Center

URL-based targeting in Userorbit allows you to precisely control where your product tours, surveys, checklists, and other engagements appear within your application. By defining specific URL rules, you can ensure that content is delivered to users at the most relevant moments in their journey.

Properties

• URL Match Types — enum — Userorbit supports several URL matching types to provide flexibility in targeting:
  • Exact Match — Targets only the specific URL provided, including query parameters. Example: https://app.userorbit.com/dashboard?plan=premium
  • Contains — Targets any URL that includes the specified string. Useful for targeting sections or pages that share a common path segment. Example: /settings would match https://app.userorbit.com/settings/profile and https://app.userorbit.com/settings/billing.
  • Starts With — Targets any URL that begins with the specified string. Ideal for targeting entire sections of your application. Example: https://app.userorbit.com/admin/ would match all pages within the admin section.
  • Regex (Regular Expression) — Provides advanced pattern matching for complex URL structures. Requires knowledge of regular expression syntax. Example: ^/products/[0-9]+/details$ to match product detail pages with a numeric ID.
• SPA Route Detection — boolean — Userorbit automatically detects route changes in Single Page Applications (SPAs) without requiring a full page reload. This ensures that URL-based targeting works seamlessly in modern web applications by monitoring URL hash changes or History API pushes.
• Query Parameter Matching — boolean — URL rules can optionally include query parameters for more granular targeting. By default, query parameters are considered part of the URL for 'Exact Match' and can be included in 'Contains', 'Starts With', or 'Regex' rules if specified.
• Combining URL Rules with User Property Rules — boolean — URL targeting can be combined with user property rules (e.g., user role, subscription plan, last activity) using logical AND/OR operators. This enables highly specific targeting scenarios, such as showing a tour only to "new users" on the "dashboard" page.

Examples

Here are common patterns for implementing URL-based targeting:

• Target all pages under a specific section (e.g., /settings):

  Use the "Starts With" match type with the value /settings. This will target URLs like https://app.userorbit.com/settings/profile, https://app.userorbit.com/settings/billing, etc.

• Target only the dashboard page:

  Use the "Exact Match" type with the value https://app.userorbit.com/dashboard (or just /dashboard if only matching the path). Ensure no query parameters are present unless explicitly needed.

• Exclude admin pages from an engagement:

  When setting up an engagement, you can add an exclusion rule. Use the "Starts With" match type with the value /admin/ and set it as an exclusion criteria. This ensures the engagement will not appear on any page within the admin section.

Notes

• For feature-specific implementation details and advanced configurations, please refer to the dedicated articles for Product Tours URL Targeting, Surveys URL Targeting, and Checklists URL Targeting.
• Regular expressions offer powerful but complex matching. Always test your regex patterns thoroughly to avoid unintended targeting.