Introduction to OpenPanel

What is OpenPanel?

OpenPanel is an open-source analytics platform that combines product analytics (like Mixpanel) with web analytics (like Plausible) into one simple solution. Whether you're tracking website visitors or analyzing user behavior in your app, OpenPanel provides the insights you need without the complexity.

Key Features

Web Analytics

• Real-time data: See visitor activity as it happens
• Traffic sources: Understand where your visitors come from
• Geographic insights: Track visitor locations and trends
• Device analytics: Monitor usage across different devices
• Page performance: Analyze your most visited pages

Product Analytics

• Event tracking: Monitor user actions and interactions
• User profiles: Build detailed user journey insights
• Funnels: Analyze conversion paths
• Retention: Track user engagement over time
• Custom properties: Add context to your events

Getting Started

1. Installation: Choose your preferred method:

   • Script tag - Quickest way to get started
   • Web SDK - For more control and TypeScript support
   • React - Native React integration
   • Next.js - Optimized for Next.js apps

2. Core Methods:

   // Track an event
   track('button_clicked', { 
     buttonId: 'signup',
     location: 'header'
   });
    
   // Identify a user
   identify({
     profileId: 'user123',
     email: '[email protected]',
     firstName: 'John'
   });

Privacy First

OpenPanel is built with privacy in mind:

• No cookies required
• GDPR and CCPA compliant
• Self-hosting option available
• Full control over your data

Open Source

OpenPanel is fully open-source and available on GitHub. We believe in transparency and community-driven development.

Need Help?

• Join our Discord community
• Check our GitHub issues
• Email us at [email protected]

Core Methods

Set global properties

Sets global properties that will be included with every subsequent event.

Track

Tracks a custom event with the given name and optional properties.

Tips

You can identify the user directly with this method.

track('your_event_name', {
  foo: 'bar',
  baz: 'qux',
  // reserved property name
  __identify: {
    profileId: 'your_user_id', // required
    email: 'your_user_email',
    firstName: 'your_user_name',
    lastName: 'your_user_name',
    avatar: 'your_user_avatar',
  }
});

Identify

Associates the current user with a unique identifier and optional traits.

Alias

Creates an alias for a user identifier.

Increment

Increments a numeric property for a user.

Decrement

Decrements a numeric property for a user.

Clear

Clears the current user identifier and ends the session.