stapel-analytics

The backend half of the Stapel analytics standard. Your frontend already declares its events and fires them through @stapel/analytics — typed track(), a consent gate, an offline queue, provider fan-out. This is what it talks to, and what the rest of your fleet talks to.

browser (@stapel/analytics)                 server modules
   │ track / page / identify                    │ analytics.track
   ▼                                            ▼
POST /analytics/api/v1/events  ──►  registry check + PII guard
                                            │
   your comm Actions ──► COMM_BRIDGE ────────┤
   (payment.completed, …)                    │
                                             ▼
                                  stapel_core.eventstore  ("analytics" stream)
                                             │
                    ┌────────────────────────┼────────────────────┐
                    ▼                        ▼                    ▼
              funnels / reports      analytics.events.recorded   erasure
              (conversion by step)   ──► adapter fan-out         (GDPR Art. 17)

Part of the Stapel framework.

Install

pip install stapel-analytics

INSTALLED_APPS = [
    ...,
    "stapel_core.django.eventstore",   # the event rows live here
    "stapel_analytics",
]

path("analytics/", include("stapel_analytics.urls"))   # -> /analytics/api/v1/...

That is the whole install. Point your frontend's collector at it and events start landing — the shipped stapelCollectorProvider needs no changes.

Declare your events once

The registry is the same analytics/events.json your frontend's gen:events already produces:

STAPEL_ANALYTICS = {"EVENTS_FILE": BASE_DIR / "analytics" / "events.json"}

One vocabulary, two runtimes. An event nobody declared is still stored — and marked unregistered, so you find the typo instead of losing the data.

Ask where people stop

STAPEL_ANALYTICS = {
    "FUNNELS": {
        "checkout": {
            "title": "Checkout",
            "steps": ["flow.checkout.started", "checkout.address",
                      "payment_completed"],
            "window_seconds": 86400,
        }
    }
}

GET /analytics/api/v1/funnels/checkout/report?compare=true

{"entered": 1204, "completed": 331, "conversion": 0.274917,
 "steps": [
   {"name": "flow.checkout.started", "count": 1204, "rate_from_first": 1.0},
   {"name": "checkout.address",      "count": 502,  "rate_from_previous": 0.416944,
    "dropoff": 702, "delta": -48},
   {"name": "payment_completed",     "count": 331,  "rate_from_previous": 0.659363,
    "dropoff": 171, "delta": 12}
 ]}

Notice the last step: payment_completed happens on a server. One line of settings makes it a step of the same funnel as the clicks before it:

STAPEL_ANALYTICS = {"COMM_BRIDGE": {"payment.completed": "payment_completed"}}

The user id is hashed exactly the way the browser hashes it, so the server step and the clicks belong to the same person.

Mirror the stream anywhere

STAPEL_ANALYTICS = {
    "ADAPTERS": {
        "webhook": {"enabled": True, "config": {"url": "https://collect…"}},
        "posthog": {"handler": "app.analytics.posthog", "enabled": True},
    }
}

Delivery rides the comm outbox, never the ingest request thread. A vendor's outage costs you nothing: the event store is the record and manage.py analytics_fanout --since … replays the mirror.

Privacy is the default, not a setting you remember

• prop values that look like an email or a phone number are refused, and the receipt names the offending prop;
• user ids are stored as a hash, never raw;
• the erasure provider ships in this same first release — analytics rows are personal data, including the anonymous session someone had before they logged in:

STAPEL_GDPR = {"DATA_OWNERS": [..., "analytics"]}

• and there is a retention horizon out of the box (400 days), with a system check if you turn it off.

Documentation

• MODULE.md — the integration contract: wire format, settings, checks, comm surface, erasure policy.
• CONFIG.MD — every setting, and the four decisions a host actually has to make.
• CHANGELOG.md — what changed, and what breaks.

License

MIT