Welcome to Highlight
Getting Started
Overview
Backend SDK
Overview
Express Backend
Go Backend
Next.js Backend
Node.js Backend
Client SDK
Angular
Overview
Gatsby.js
HTML
Next.js
Other
React.js
Shopify
Squarespace
SvelteKit
Vue.js
Webflow
WordPress
Next.js SDK
Highlight()
Metrics
nope
Overview
withHighlightConfig()
Tips
Content-Security-Policy
Local Development
Monkey Patches
Performance Impact
Proxying Highlight
Session Search Deep Linking
Troubleshooting
Upgrading Highlight
Session Replay
Console Messages
HTML iframe Recording
Identifying Users
Live Mode
Network DevTools
Privacy
Rage Clicks
Recording Network Requests and Responses
Session Sharing
Session Shortcut
Tracking Events
Versioning Sessions
Error Monitoring
Grouping Errors
Sourcemaps
Versioning Errors
Product Features
Alerts
Analytics
Canvas
Comments
Environments
Frontend Observability
Keyboard Shortcuts
Performance Data
Segments
Session Search
Team Management
User Feedback
Web Vitals
WebGL
Integrations
Amplitude Integration
Clearbit Integration
Electron Integration
Front Plugin
Intercom Integration
Linear Integration
Mixpanel Integration
React.js Integration
Segment Integration
Sentry Integration
Slack Integration
Vercel Integration
highlight.run Changelog
5.0.0
Menu

Session Search Deep Linking

The queries you build when searching for sessions are reflected in the URL parameters. You can share these URLs with others to deep link to search results, or even create them programatically.

Syntax

/sessions?query={and|or}||{property1},{operator1},{valueA},{valueB}

  • Highlight supports and and or queries

  • User properties:

    • user_{your_property_name}
  • Track properties:

    • track_{your_property_name}
  • Sessions built-in properties (these are automatically populated by Highlight):

    • user_identifier

    • session_browser_version

    • session_browser_name

    • session_device_id

    • session_environment

    • session_os_name

    • session_os_version

    • session_referrer

    • session_reload

    • session_visited-url

    • custom_app_version

    • custom_created_at

    • custom_active_length

    • custom_viewed

    • custom_processed

    • custom_first_time

    • custom_starred

  • Operators:

    • is

    • is_not

    • contains

    • not_contains

    • exists

    • not_exists

    • matches (uses Lucene regex syntax)

    • not_matches (uses Lucene regex syntax)

    • between (for active_length)

    • not_between (for active_length)

    • between_date (for created_at)

    • not_between_date (for created_at)

Examples

Viewing sessions for a particular user:

/sessions?query=and||user_identifier,is,alice@example.com

Excluding sessions from your organization:

/sessions?query=and||user_identifier,not_contains,@yourdomain.com

Viewing sessions for a particular page in your app:

/sessions?query=and||session_visited-url,contains,/your/path/name

Multiple properties

/sessions?query=or||user_identifier,is,Bob||user_email,is_not,alice@example.com