> For the complete documentation index, see [llms.txt](https://docs.tatakai.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tatakai.me/extensions/extension-capabilities/analytics-capability.md). # Analytics capability Extensions can contribute analytics sinks **data-driven** (declarative POST endpoints) or **code-driven** (custom provider with full API). Data-driven works for all installed extensions; code-driven requires trust. *** ## Data-Driven Analytics (Manifest) Declared in `manifest.json` → `contributes.analytics[]`. Registered at boot via `bootstrapExtensions.ts`. ```json { "contributes": { "analytics": [ { "ingestUrl": "https://analytics.example.com/ingest", "events": ["play", "pause", "seek", "episode_complete", "source_resolve"] }, { "ingestUrl": "https://metrics.example.com/tatakai", "events": [] } ] } } ``` Empty `events` forwards all events. ### Payload Format Every event POSTs JSON to `ingestUrl`: ```json { "type": "event" | "pageview" | "error", "name": "play", "payload": { "anilistId": 12345, "episode": 1, "quality": "1080p", "source": "Gogoanime" }, "ts": 1705756800000 } ``` | Type | Name Examples | Payload | | ---------- | ----------------------------------------------------------------------------------------------- | ----------------------------- | | `event` | `play`, `pause`, `seek`, `episode_complete`, `source_resolve`, `download_start`, `theme_change` | Event-specific | | `pageview` | `/watch/123/1`, `/read/456/1`, `/settings` | `{ title, path }` | | `error` | `source_failed`, `playback_error`, `sync_failed` | `{ message, stack, context }` | ### Implementation ```ts // bootstrapExtensions.ts function makeIngestProvider(extensionId: string, idx: number, cfg: ContributedAnalytics): AnalyticsProvider { const allow = new Set((cfg.events || []).filter(Boolean)); const shouldSend = (name: string) => allow.size === 0 || allow.has(name); const post = (type: string, name: string, payload: Record) => { if (!shouldSend(name)) return; fetch(cfg.ingestUrl, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ type, name, payload, ts: Date.now() }), keepalive: true, // Survives page transitions }).catch(() => { /* ignore network errors */ }); }; return { id: `${extensionId}:analytics:${idx}`, trackEvent: (name, params) => post('event', name, params || {}), trackPageView: (path, title) => post('pageview', path, { title }), trackError: (error, context) => post('error', error.message, { ...context }), }; } ``` {% hint style="info" %} **Fire-and-forget:** Uses `keepalive: true` to survive navigation. Network errors silently ignored. {% endhint %} *** ## Code-Driven Analytics (Renderer) For custom logic (batching, sampling, enrichment), implement `AnalyticsProvider` in renderer bundle: ```ts // renderer.js export async function activate(ctx) { const provider: AnalyticsProvider = { id: `${ctx.extensionId}:custom-analytics`, trackEvent: (name, params) => { // Custom logic: batch, sample, enrich, transform myAnalyticsQueue.push({ name, params, timestamp: Date.now() }); if (myAnalyticsQueue.length >= 10) flush(); }, trackPageView: (path, title) => { myAnalyticsQueue.push({ type: 'pageview', path, title, timestamp: Date.now() }); }, trackError: (error, context) => { // Send immediately for errors sendToEndpoint({ type: 'error', error: error.message, context }); }, }; ctx.analytics.registerProvider(provider); } ``` ### AnalyticsProvider Interface ```ts interface AnalyticsProvider { id: string; // Namespaced trackEvent: (name: string, params?: Record) => void; trackPageView: (path: string, title?: string) => void; trackError?: (error: Error, context?: Record) => void; } ``` ### Registration ```ts // ExtensionContext.analytics analytics.registerProvider(provider); ``` {% hint style="warning" %} **Trust-gated:** Only loads for trusted extensions. {% endhint %} *** ## Core Analytics Service **File:** `src/core/analytics/AnalyticsService.ts` ```ts class AnalyticsService { private providers: Map = new Map(); registerProvider(provider: AnalyticsProvider) { ... } unregisterProvider(id: string) { ... } // Fan-out to all registered providers trackEvent(name: string, params?: Record) { this.providers.forEach(p => p.trackEvent?.(name, params)); } trackPageView(path: string, title?: string) { ... } trackError(error: Error, context?: Record) { ... } } ``` ### Auto-tracked Events (Core) | Event | When | | ------------------- | ----------------------- | | `app_boot` | App startup | | `theme_change` | Theme switched | | `language_change` | Language switched | | `playback_start` | Video playback begins | | `playback_complete` | Episode finishes | | `source_resolve` | Sources fetched | | `download_start` | Download queued | | `download_complete` | Download finishes | | `sync_start` | MAL/AniList sync begins | | `sync_complete` | Sync finishes | | `extension_install` | Extension installed | | `extension_enable` | Extension enabled | *** ## Testing Checklist * [ ] Data-driven: `ingestUrl` is HTTPS * [ ] Data-driven: `events` allowlist works (empty = all) * [ ] Data-driven: `keepalive: true` survives navigation * [ ] Code-driven: Provider implements all three methods * [ ] Code-driven: Batching/sampling doesn't lose critical events * [ ] Code-driven: Errors sent immediately * [ ] Both: Events appear in external dashboard * [ ] Both: No console errors on network failure *** ## Privacy Notes * **No PII** in payloads (only anilistId, episode, quality, source name) * **Opt-out:** Users can disable analytics in Settings → Privacy * **Local-first:** Core analytics can run without external endpoints * **Transparent:** All events documented above *** ## Related * [Extension Overview](/extensions/extension-overview.md) * [Manifest Reference](/extensions/extension-manifest.md) * [Themes Capability](/extensions/extension-capabilities/themes.md) * [UI Slots/Pages](/extensions/extension-capabilities/ui-slots.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.tatakai.me/extensions/extension-capabilities/analytics-capability.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.