Userpilot Glossary
This glossary defines key terms used in Userpilot documentation and product interfaces.Content Types
Flow
A sequence of in-app UI elements (modals, tooltips, slideouts) that guide users through tasks or communicate information. Flows can be triggered automatically or manually.Spotlight
A category of elements that highlight specific parts of your UI:- Native Tooltip: Text that appears on hover over an element
- Hotspot: A pulsing indicator that draws attention to an element
- Button: A persistent clickable element added to your UI
Banner
A horizontal message bar displayed at the top or bottom of a page for announcements, alerts, or promotions.Checklist
A persistent widget showing tasks for users to complete, typically used for onboarding. Tasks can link to flows, URLs, or trigger JavaScript actions.Resource Center
A help widget that provides self-service support, including help articles, videos, flows, and external links.Survey
A form for collecting user feedback with various question types (NPS, rating, multiple choice, open text).NPS (Net Promoter Score)
A specific survey type asking βHow likely are you to recommend us?β on a 0-10 scale, categorizing users as Detractors (0-6), Passives (7-8), or Promoters (9-10).Data Concepts
User
An individual who interacts with your application. Users are identified by a uniqueuser_id and can have custom properties (name, email, plan, etc.).
Company (Account)
An organization that groups multiple users. Companies are identified by a uniqueid within the userβs company object and can have custom properties.
Segment
A dynamic group of users or companies based on filters (properties, events, behavior). Segments update automatically as users match or unmatch criteria.Event
A recorded user action, either:- Tracked Event: Explicitly sent via
userpilot.track() - Auto-captured Event: Automatically recorded clicks, form submissions, page views
- Labeled Event: An auto-captured event given a meaningful name via Visual Labeler
Property
An attribute stored on a user, company, or event. Properties can be strings, numbers, dates, or booleans.Feature Tag
A labeled UI element or event representing a product feature, used to measure feature adoption and usage.Targeting Concepts
Audience
The set of users who can see a piece of content, defined by segment membership, user properties, or company properties.Trigger
The condition that causes content to display:- Page load: When a user visits a specific URL
- Element click: When a user clicks a specific element
- Custom event: When a tracked event fires
- Manual: Via JavaScript API call
Frequency
How often content displays to a user:- Once: Only the first time conditions are met
- Every time: Each time conditions are met
- Until completed: Until user completes the content
Page Targeting
URL matching rules that determine where content can appear. Supports equals, starts with, contains, ends with, and matches regex conditions; in a matches regex condition, an asterisk (*) can stand for any text.
SDK Concepts
Identify
The process of telling Userpilot who the current user is viauserpilot.identify(user_id, properties). Required before content displays.
Reload
Notifying Userpilot of a page change in single-page applications viauserpilot.reload(). Required for SPAs to trigger page-based content.
Track
Recording a custom event viauserpilot.track(event_name, metadata). Used for measuring actions and triggering content.