Documentation

const serla = new Serla('sk_live_your_api_key');
serla.track('page_view', { page: '/home' });

curl -X POST https://serla.dev/api/v1/events \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "test_event"}'

<script src="/serla.js"></script>
<script>
  const serla = new Serla('sk_live_your_api_key');
  serla.trackPageView();
</script>

import { Serla } from './serla.js';
const serla = new Serla('sk_live_your_api_key');

const serla = new Serla('sk_live_your_api_key', {
  // API endpoint (default: https://serla.dev/api/v1)
  endpoint: 'https://serla.dev/api/v1',

  // Enable debug logging (default: false)
  debug: true,

  // Batch size before auto-flush (default: 10)
  batchSize: 10,

  // Flush interval in ms (default: 5000)
  flushInterval: 5000,

  // Auto-track page views (default: false)
  autoTrackPageViews: true,

  // Respect Do Not Track header (default: true)
  respectDoNotTrack: true,

  // Session timeout in minutes (default: 30)
  sessionTimeout: 30
});

// Batched - efficient for high volume
serla.track('page_view', { page: '/home' });
serla.track('button_click', { button: 'cta' });

// Immediate - for critical events
await serla.send('purchase', {
  distinctId: 'user_123',
  properties: { revenue: 99.99 }
});

// Simple event
serla.track('button_click');

// Event with properties
serla.track('purchase', {
  properties: {
    product_id: 'prod_123',
    product_name: 'Pro Plan',
    price: 49.99,
    currency: 'USD'
  }
});

// Event with user ID
serla.track('signup', {
  distinctId: 'user_456',
  properties: {
    plan: 'pro',
    source: 'google_ads'
  }
});

serla.track('purchase_completed', {
  distinctId: 'user_123',
  properties: {
    revenue: 149.99,
    quantity: 2,
    product: 'Pro Plan',
    currency: 'USD'
  }
});

// Basic identification
serla.identify('user_123', {
  email: 'john@example.com',
  name: 'John Doe'
});

// Full user profile
serla.identify('user_123', {
  // Contact info
  email: 'john@example.com',
  name: 'John Doe',
  phone: '+1234567890',

  // Account info
  plan: 'pro',
  created_at: '2024-01-15T10:30:00Z',

  // Company info (B2B)
  company: 'Acme Inc',
  company_size: '50-100',
  industry: 'Technology',

  // Custom properties
  lifetime_value: 499.99
});

serla.reset();
// Generates new anonymous session ID

// Basic page view
serla.trackPageView();

// With custom properties
serla.trackPageView({
  title: 'Pricing Page',
  section: 'marketing'
});

import { useLocation } from 'react-router-dom';

function App() {
  const location = useLocation();

  useEffect(() => {
    serla.trackPageView();
  }, [location.pathname]);
}

// Send all queued events immediately
await serla.flush();

// Flush before page unload (handled automatically)
window.addEventListener('beforeunload', () => {
  serla.flush();
});

curl -X POST https://serla.dev/api/v1/events/batch \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      { "name": "page_view", "properties": { "page": "/home" } },
      { "name": "button_click", "properties": { "button": "cta" } }
    ]
  }'

X-RateLimit-Limit: 50
X-RateLimit-Remaining: 49
X-RateLimit-Reset: 1705312800

async function trackWithRetry(event, maxRetries = 3) {
  for (let i = 0; i < maxRetries; i++) {
    try {
      return await serla.track(event);
    } catch (error) {
      if (error.status === 429) {
        const delay = Math.pow(2, i) * 1000;
        await new Promise(r => setTimeout(r, delay));
      } else {
        throw error;
      }
    }
  }
}

{
  "id": "wh_abc123",
  "type": "event.created",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "event": {
      "id": "evt_xyz",
      "name": "purchase",
      "distinctId": "user_123",
      "properties": { "price": 49.99 }
    }
  }
}

const crypto = require('crypto');

function verifyWebhook(payload, signature, secret) {
  const expected = 'sha256=' + crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');

  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expected)
  );
}

// Check opt-out before initializing
if (!localStorage.getItem('serla_optout')) {
  const serla = new Serla('sk_live_...');
}

// Opt-out function for privacy settings
function optOut() {
  localStorage.setItem('serla_optout', 'true');
  serla.reset();
}

try {
  await serla.track('event');
} catch (error) {
  if (error.code === 'rate_limit_exceeded') {
    // Wait and retry
  } else if (error.code === 'unauthorized') {
    // Check API key
  } else {
    console.error('Serla error:', error.message);
  }
}

const serla = new Serla('sk_live_...', { debug: true });

// Or toggle at runtime
serla.setDebug(true);