How umami-software/umami works
Umami is a privacy-focused web and product analytics platform. A site’s tracker sends events to collection endpoints, which validate and enrich them, resolve sessions, and save analytics data; users then explore reports and session behavior in the web app. The product also includes site/team administration, shareable boards, and an MCP interface. The graph emphasizes relationships visible in excerpts or the source index; unsampled report and integration wiring is kept dashed or omitted.
Main entry points: route.ts Event collection API · sql Analytics queries · load.ts Entity loaders · useApi.ts Query and filters
Components 24
Event collection
- Browser tracker
src/tracker/index.ts - Session recorder
src/recorder/index.js - Event collection API
src/app/api/send/route.ts - Replay and heatmap API
src/app/api/record/route.ts - Session resolution
src/lib/collection-session.ts
Analytics experience
- Analytics dashboard
src/app/(main)/websites/[websiteId]/WebsitePage.tsx - Analytics reports
src/app/(main)/websites/[websiteId]/(reports) - Sessions and replays
src/app/(main)/websites/[websiteId]/sessions - Query and filters
src/components/hooks/useApi.ts
Sites and sharing
- Site and team admin
src/app/(main)/admin - Boards and sharing
src/app/(main)/boards - Website API
src/app/api/websites/route.ts - Boards API
src/app/api/boards/route.ts
API and persistence
- Request validation
src/lib/request.ts - Entity loaders
src/lib/load.ts - Analytics queries
src/queries/sql - Product queries
src/queries/prisma/index.ts - Analytics store
src/lib/clickhouse.ts - Application database
- Redis cache
src/lib/redis.ts
Client integrations
- Typed API client
packages/api-client/src/client.ts - MCP server
packages/mcp/src/server.ts - MCP HTTP endpoint
src/app/mcp/route.ts
Other components
- Site visitor
Connections 26
- Site visitor → Browser tracker: uses
- Browser tracker → Event collection API: sends events
- Site visitor → Session recorder: uses
- Session recorder → Replay and heatmap API: submits recordings
- Event collection API → Request validation: parses request
src/app/api/send/route.ts - Event collection API → Entity loaders: loads website
src/app/api/send/route.ts - Event collection API → Session resolution: resolves session
src/app/api/send/route.ts - Event collection API → Analytics queries: saves events
src/app/api/send/route.ts - Replay and heatmap API → Request validation: parses request
src/app/api/record/route.ts - Replay and heatmap API → Analytics queries: stores replay data
src/app/api/record/route.ts - Analytics dashboard → Query and filters: requests data
- Query and filters → Typed API client: calls API
- Analytics reports → Query and filters: uses queries
- Sessions and replays → Query and filters: uses queries
- Analytics queries → Analytics store: queries analytics
src/lib/clickhouse.ts - Analytics queries → Application database: queries records
- Product queries → Application database: queries records
- Entity loaders → Product queries: loads website
src/lib/load.ts - Entity loaders → Analytics queries: loads session
src/lib/load.ts - Entity loaders → Redis cache: caches entities
src/lib/load.ts - Site and team admin → Website API: manages sites
- Boards and sharing → Boards API: manages boards
- Boards API → Product queries: queries boards
src/app/api/boards/route.ts - Website API → Product queries: queries websites
src/app/api/websites/route.ts - MCP HTTP endpoint → MCP server: dispatches requests
src/app/mcp/route.ts - MCP server → Typed API client: uses client
packages/mcp/src/server.ts