Documentation

Learn how to integrate and maximize our analytics platform with comprehensive guides, API references, and examples.

main.js

Package.json

import { Analytics } from '@analytics/core'

const analytics = new Analytics({
  apiKey: 'your-api-key',
  options: {
    // your configuration
  }
})

analytics.track('Page View', {
  page: '/home',
  referrer: document.referrer
})

Get Started

Quick Start Guide

Follow these simple steps to integrate analytics into your application. Get up and running in minutes.

1. Install the package

Start by installing our core package and React integration.

npm install @analytics/core @analytics/react

2. Initialize Analytics

Create an Analytics instance with your API key.

import { Analytics } from '@analytics/core'
import { AnalyticsProvider } from '@analytics/react'

const analytics = new Analytics({
  apiKey: process.env.NEURALYZE_API_KEY
})

3. Wrap your app

Wrap your application with the AnalyticsProvider.

export default function App({ Component, pageProps }) {
  return (
    <AnalyticsProvider instance={analytics}>
      <Component {...pageProps} />
    </AnalyticsProvider>
  )
}

4. Start tracking

Use the analytics hook to track events in your components.

import { useAnalytics } from '@analytics/react'

export default function MyComponent() {
  const analytics = useAnalytics()
  
  const handleClick = () => {
    analytics.track('Button Clicked', {
      buttonId: 'signup',
      location: 'hero'
    })
  }
}

Documentation

Everything you need to know

Browse through our comprehensive documentation to learn everything about integrating and using our analytics platform.

Getting Started

Learn the basics of setting up and configuring the analytics platform.

Installation Configuration First Steps

API Reference

Detailed documentation of all available API endpoints and methods.

Authentication Events API Users API

SDK Integration

Integrate analytics into your applications with our SDKs.

React SDK Node.js SDK Python SDK

Guides & Tutorials

Step-by-step guides and tutorials for common use cases.

Event Tracking User Identification Custom Analytics

CLI Tools

Command-line tools for managing your analytics setup.

CLI Installation Commands Configuration

Self-Hosting

Deploy and manage your own analytics infrastructure.

Requirements Docker Setup Configuration

Code Examples

Integration Examples

See how easy it is to integrate our analytics platform with your favorite programming language or framework.

React Example

import { useAnalytics } from '@analytics/react'

function CheckoutButton() {
  const analytics = useAnalytics()

  const handleCheckout = async () => {
    // Track the checkout event
    analytics.track('Checkout Started', {
      cartValue: 99.99,
      currency: 'USD',
      items: [
        { id: 'prod_123', name: 'Premium Plan' }
      ]
    })
    
    // Proceed with checkout
    await startCheckout()
  }

  return (
    <button onClick={handleCheckout}>
      Checkout
    </button>
  )
}

Community

Join our developer community

Get help, share knowledge, and connect with other developers building with our analytics platform.

Community Forum10k+ members: Connect with other developers, share knowledge, and get help from the community.
Developer DiscordActive 24/7: Join our Discord server for real-time discussions and instant support.
GitHub Discussions5k+ discussions: Participate in technical discussions, feature requests, and bug reports.
Knowledge Base200+ articles: Browse our extensive collection of guides, tutorials, and FAQs.