collector · recipes

Documentation

All events are sent as JSON to a single POST /collect/ endpoint. The site tag pushes page_view, click, scroll, and page_leave automatically — everything else is a one-liner on collectorQueue, or a raw HTTP call from any language.

Attach a handler to any interactive element. The event name is whatever you want to measure later.

onclick="collectorQueue.push({event: 'signup_cta_click'})"

Use this for SPA route changes, funnel checkpoints ("invoice paid"), or any meaningful page-level moment. Push once per visit:

<script>collectorQueue.push({event: 'checkout_success'});</script>

Every event is stored as JSON in a data field. Add whatever keys you need — no migration required, query with Django ORM data__user_segment lookups later.

<script>collectorQueue.push({event: 'admin_page_view', data: {user_segment: 'admins'}});</script>

The collector endpoint is plain JSON — any HTTP client will do. Include a valid collector_id, event, and optional data.

curl -X POST -H 'Content-Type: application/json' \
  -d '{"collector_id": "PROPERTY_COLLECTOR_ID", "event": "custom_app_event", "data": {"app_id": 4}}' \
  YOUR_COLLECTOR_SERVER/collect/

Any backend, any library, any runtime. Here's a Python example using requests:

import requests

requests.post(
    'YOUR_COLLECTOR_SERVER/collect/',
    json={'collector_id': 'PROPERTY_COLLECTOR_ID',
          'event': 'subscription_renewed',
          'data': {'plan': 'pro', 'mrr': 49}}
)

Documentation

Collect custom clicks

Collect custom page views

Attach custom data to any event

Send events over raw HTTP

Server-side events (Python)