Documentation Index
Fetch the complete documentation index at: https://mintlify.com/vemetric/vemetric/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Custom events in Vemetric allow you to track any user interaction on your website. While page views are tracked automatically, custom events give you deep insights into button clicks, form submissions, video plays, purchases, and any other action that matters to your business.What are Custom Events?
Custom events represent specific user actions:- Button clicks (“Add to Cart”, “Download”, “Sign Up”)
- Form submissions (contact forms, newsletter signups)
- Media interactions (video plays, audio starts)
- Purchases and transactions
- Feature usage (search, filters, settings changes)
- Any custom action you want to track
Unlike page views which are automatically tracked, custom events require you to implement tracking code in your application.
Tracking Custom Events
Implement event tracking using the Vemetric SDK:Event Naming Conventions
Follow these best practices for event names:Use descriptive names
Use descriptive names
Choose names that clearly describe the action: “Purchase Completed” instead of “Event 1”
Be consistent
Be consistent
Use the same naming pattern across your application (e.g., “Verb + Noun” like “Button Clicked”, “Form Submitted”)
Use past tense
Use past tense
Name events as completed actions: “Downloaded” instead of “Download”
Avoid special characters
Avoid special characters
Stick to letters, numbers, and spaces for better compatibility
Event Properties
Enrich your events with additional context using properties:Property Data Types
Event properties support multiple data types:- Strings: Text values (
"Product Demo","mobile") - Numbers: Integers or decimals (
42,19.99) - Booleans: True/false values (
true,false) - Dates: ISO date strings (
"2024-03-15T10:30:00Z")
Common Property Patterns
- E-commerce
- Forms
- Content
- Features
Events Page
The Events page shows a real-time stream of all events happening on your website:Live Event Stream
View events as they occur:- Real-time updates: New events appear automatically every 5 seconds
- Live indicator: Green “Live” badge shows the stream is active
- Chronological order: Most recent events appear at the top
- Date separators: Events grouped by day for easy navigation
Event Card Information
Each event card displays:- Event name: The action that was tracked
- Timestamp: Exact date and time (with “time ago” indicator)
- User information: Avatar and display name/identifier
- Page context: Which page the event occurred on
- Device info: Browser, OS, and device type
- Event properties: Custom data attached to the event
Event Properties View
Expanded event cards show all properties:Navigating to User Journey
From any event card:- Click the user avatar or name to view their complete journey
- See all events from that user in chronological order
- Understand the context around this specific event
Filtering Events
Narrow down the event stream to find specific events:Filter Combinations
Combine multiple filters for precise analysis:- Event + Geography: See “Purchase Completed” events from United States
- Event + Device: Track “Sign Up” events on mobile devices
- Event + Browser: Find events from specific browser versions
- Multiple Events: Show several related events together
Filters on the Events page use OR logic within the same filter type and AND logic across different filter types.
Dashboard Event Analytics
Events also appear in your dashboard:Events Card
The dashboard Events card shows:- Total event count for the selected time period
- Event breakdown by event name
- Event counts per event type
- Trend indicators comparing to previous period
Event Chart Overlay
Add event volume to your dashboard chart:- The chart shows events as bars overlaid on your metrics
- See how event frequency correlates with user activity
- Toggle events on/off using the chart controls
- Identify traffic spikes and their relationship to user actions
Event Properties Analysis
Click any event in the dashboard card to:- View all properties tracked with that event
- See property value distribution
- Click a property to see all unique values
- Analyze how property values change over time
Event in Funnels
Use custom events as funnel steps:Use Cases
E-commerce Tracking
Track product views, add-to-cart, checkout initiation, and purchase completion.
Form Analytics
Monitor form starts, field interactions, validation errors, and successful submissions.
Feature Usage
Understand which features users engage with and how often.
Content Engagement
Track article reads, video plays, downloads, and social shares.
Error Tracking
Log when users encounter errors or issues.
A/B Testing
Track which variant users see and their subsequent actions.
Event Pagination
The Events page loads events in batches:- 50 events per page initially loaded
- “Load More” button to fetch older events
- Infinite scroll capability
- Real-time updates at the top
Real-Time Updates
The event stream updates automatically:- New events appear at the top every 5 seconds
- No manual refresh needed
- Live indicator shows connection status
- Smooth animations for new events
The event stream will pause updates if you scroll down to review older events. Scroll back to the top to resume real-time updates.
Event Best Practices
Track meaningful actions
Focus on events that provide business value or insights into user behavior.
Include relevant properties
Add context that helps you analyze and segment events, but avoid over-tracking.
Common Implementation Patterns
Button Click Tracking
Form Submission Tracking
Video Play Tracking
Debugging Events
Troubleshoot event tracking issues:- Check browser console: Look for Vemetric SDK errors
- View Events page: Confirm events appear in real-time
- Verify properties: Expand events to check property values
- Test in isolation: Track test events to verify SDK connection
- Check network tab: Ensure event requests are sent successfully
Next Steps
Installation
Set up the Vemetric SDK to start tracking events
User Journeys
See how events build complete user journey timelines
Funnels
Use events as funnel steps for conversion tracking
Filtering
Filter events by user attributes and properties