extension.report

SDK 0.6.1 integration docs

Add Extension Report without guessing.

Everything here is written so a developer or AI agent can integrate the current modular SDK, choose the right browser context, configure remote instrumentation groups, and understand what appears in the dashboard.

Recommended path

  1. 01 Run the Quick Start and confirm the first event.
  2. 02 Read the SDK Guide for browser-specific behavior.
  3. 03 Use the Complete Reference for edge cases or direct API work.
  4. 04 Give the Agent File to Codex or Claude for implementation work.

Docs map

Choose the right entry point.

These are the canonical entry points. The header stays clean; this page is the navigation.

Quick Start

Install the SDK, update the manifest, initialize once, add user opt-out, and verify the first event.

Best first page for a new integration.

SDK Guide

Understand contexts, automatic listeners, helper calls, queueing, consent, retries, and dashboard signals.

Use it to implement the product correctly.

Complete Reference

Full product, SDK, browser, API, consent, privacy, limits, and troubleshooting contract.

Reference-grade details for edge cases.

Owner Stats API

Read daily project metrics from your backend or reporting job with Bearer-secret authentication.

Use it for private dashboards and exports.

Agent File

Plain-text integration brief for Codex, Claude, or another AI coding agent.

Point the agent here when it needs all context.

What gets tracked

Owner telemetry, not page analytics.

Installs, updates, starts, heartbeats, active installations, and version adoption.
Toolbar state, popup opens, options page opens, side panel opens, and action icon clicks.
Permissions, optional permission prompts, context menus, notifications, shortcuts, and omnibox usage.
Telemetry opt-out, custom product events, daily counters, uninstall feedback, browser/OS/locale metadata, and delivery errors.

Implementation standard

The default integration shape.

The normal path is to install @extension-report/js, initialize it once from the background or service worker with the public project key, and let automatic browser listeners collect the standard lifecycle and engagement events. SDK 0.6.1exposes Adoption, Engagement, and Reliability as coherent runtime groups that can be reduced remotely without a store release.

Explicit helper calls are only needed where browser APIs cannot expose enough context: declared popups, content scripts, optional permission prompts, notification shown events, options pages, side panels, high-frequency counters, the user telemetry opt-out setting, and custom product actions.

Agent instruction

For AI-assisted implementation, point the agent to /docs/ai.txt first, then ask it to apply the SDK Guide rules to the extension source.