Metrone Documentation

<script defer src="https://cdn.metrone.io/m.js" data-key="metrone_live_YOUR_KEY"></script>

https://api.metrone.io/v1/webhooks/vapi/main?key=metrone_live_YOUR_KEY

<script defer
  src="https://data.yoursite.com/m.js"
  data-key="metrone_live_YOUR_API_KEY"
  data-api="https://data.yoursite.com/v1/events">
</script>

npm install @metrone-io/sdk

import { Metrone } from '@metrone-io/sdk'

const metrone = new Metrone('metrone_live_YOUR_API_KEY')

// Page views are tracked automatically
metrone.track('signup', { plan: 'growth', source: 'landing' })

const metrone = new Metrone({
  apiKey: 'metrone_live_YOUR_API_KEY',
  autoTrackSPA: true,
})

import { Metrone } from '@metrone-io/sdk'
import type { AnalyticsConfig } from '@metrone-io/sdk'

const config: AnalyticsConfig = {
  apiKey: 'metrone_live_YOUR_API_KEY',
  autoTrackSPA: true,
  batchSize: 10,          // events per batch
  flushInterval: 5000,    // ms between flushes
  debug: false,
  respectDoNotTrack: false,
  anonymizeIP: true,
}

const metrone = new Metrone(config)

npm install @metrone-io/react @metrone-io/sdk

import { MetroneProvider } from '@metrone-io/react'

function App() {
  return (
    <MetroneProvider
      config={{ apiKey: 'metrone_live_YOUR_API_KEY', autoTrackSPA: true }}
      trackRouteChanges
    >
      <YourApp />
    </MetroneProvider>
  )
}

import { useMetrone } from '@metrone-io/react'

function CheckoutButton() {
  const { trackEvent, trackConversion } = useMetrone()

  return (
    <button onClick={() => {
      trackConversion('purchase', 69, { plan: 'growth' })
    }}>
      Buy now
    </button>
  )
}

export default {
  async fetch(request) {
    const url = new URL(request.url)

    if (url.pathname === '/m.js')
      return fetch('https://api.metrone.io/m.js')

    if (url.pathname.startsWith('/v1/'))
      return fetch('https://api.metrone.io' + url.pathname, {
        method: request.method,
        headers: request.headers,
        body: request.body,
      })

    return fetch(request)
  },
}

<script defer
  src="https://yoursite.com/m.js"
  data-key="metrone_live_YOUR_API_KEY"
  data-api="https://yoursite.com/v1/events">
</script>

metrone.track('purchase', {
  plan: 'growth',
  value: 69,
  currency: 'USD',
})

metrone.conversion('signup', 1, { source: 'landing' })
metrone.interaction('click', 'cta_hero')

curl -X POST https://api.metrone.io/v1/events \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "metrone_live_YOUR_API_KEY",
    "event_type": "custom",
    "event_name": "purchase",
    "source": "web",
    "page_url": "https://yoursite.com/checkout",
    "properties": { "plan": "growth", "value": 69 }
  }'

npm install @metrone-io/server

import { MetroneServer } from '@metrone-io/server'

const metrone = new MetroneServer({
  apiKey: 'metrone_live_YOUR_API_KEY',
})

// Track events
metrone.pageview('https://yoursite.com/pricing', 'Pricing')
metrone.track('api_request', { endpoint: '/users', method: 'GET' })

// Track AI interactions
metrone.trackAICall({
  callId: 'call_abc123',
  provider: 'vapi',
  duration: 47,
  intent: 'book_appointment',
  outcome: 'completed',
})

// Graceful shutdown (flushes pending events)
await metrone.shutdown()

// Read aggregated stats
const stats = await metrone.getStats({ days: 30 })
console.log(stats.pageviews, stats.unique_visitors)

// Read events with pagination
const events = await metrone.getEvents({ limit: 50, event_type: 'conversion' })

// Get live visitor count
const live = await metrone.getLive()
console.log(live.active_visitors)

import { MetroneServer, MetroneAuthError, MetroneRateLimitError } from '@metrone-io/server'

try {
  await metrone.flush()
} catch (err) {
  if (err instanceof MetroneAuthError) { /* invalid API key */ }
  if (err instanceof MetroneRateLimitError) { /* back off */ }
}

npm install -g @metrone-io/mcp

{
  "mcpServers": {
    "metrone": {
      "command": "npx",
      "args": ["@metrone-io/mcp"],
      "env": {
        "METRONE_API_KEY": "metrone_live_YOUR_API_KEY"
      }
    }
  }
}

https://api.metrone.io/v1/webhooks/{platform}/{endpointId}?key=metrone_live_YOUR_API_KEY

# Examples
https://api.metrone.io/v1/webhooks/twilio/main?key=metrone_live_...
https://api.metrone.io/v1/webhooks/vapi/support-agent?key=metrone_live_...
https://api.metrone.io/v1/webhooks/retell/sales?key=metrone_live_...
https://api.metrone.io/v1/webhooks/telnyx?key=metrone_live_...
https://api.metrone.io/v1/webhooks/intercom?key=metrone_live_...
https://api.metrone.io/v1/webhooks/zendesk?key=metrone_live_...

# One restaurant, multiple locations
.../v1/webhooks/twilio/falls-church?key=...
.../v1/webhooks/twilio/rockville?key=...
.../v1/webhooks/twilio/main-line?key=...

curl -X POST https://api.metrone.io/v1/events \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "metrone_live_YOUR_API_KEY",
    "event_type": "ai_call",
    "source": "voice",
    "ai_provider": "vapi",
    "ai_call_id": "call_abc123",
    "ai_intent": "book_appointment",
    "ai_duration_sec": 47
  }'

curl -X POST https://api.metrone.io/v1/events/batch \
  -H "Content-Type: application/json" \
  -d '[
    { "api_key": "metrone_live_...", "event_type": "pageview", "page_url": "https://..." },
    { "api_key": "metrone_live_...", "event_type": "conversion", "properties": { "value": 99 } }
  ]'

curl https://api.metrone.io/v1/api/stats?days=30 \
  -H "X-Api-Key: metrone_live_YOUR_API_KEY"

curl -X POST https://api.metrone.io/v1/api/query \
  -H "X-Api-Key: metrone_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "queries": [
      { "type": "stats", "params": { "days": 7 } },
      { "type": "pages", "params": { "limit": 10 } },
      { "type": "live" }
    ]
  }'

curl -N https://api.metrone.io/v1/api/stream \
  -H "X-Api-Key: metrone_live_YOUR_API_KEY"

# Events arrive as they happen:
# data: {"event_type":"pageview","page_path":"/pricing","timestamp":"..."}
# data: {"event_type":"conversion","source":"voice","ai_provider":"twilio",...}

const es = new EventSource(
  'https://api.metrone.io/v1/api/stream?api_key=metrone_live_YOUR_API_KEY'
)

es.onmessage = (e) => {
  const event = JSON.parse(e.data)
  console.log(event.event_type, event.page_path)
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests. Try again in 60 seconds.",
    "status": 429,
    "request_id": "req_abc123_xyz789"
  }
}