Skip to content

Post-Event/composite-sdk-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Composite Analytics SDK Documentation

This repository contains the official documentation for the Composite Analytics SDK - a modern, privacy-first analytics solution for web applications and Chrome Extensions.

Overview

Composite Analytics provides powerful analytics tools with a focus on:

  • Event Tracking - Track custom events and user interactions
  • Session Recording - Replay user sessions to understand behavior
  • Chrome Extension Support - First-class support for browser extensions
  • Privacy-First - Built-in data masking and GDPR compliance
  • Lightweight - Core SDK is only ~5KB gzipped with lazy loading

Documentation Structure

composite-sdk-docs/
├── index.mdx                     # Landing page
├── sdk/
│   ├── quickstart.mdx           # 5-minute setup guide
│   ├── installation.mdx         # Detailed installation instructions
│   ├── integrations/
│   │   └── chrome-extension.mdx # Chrome Extension integration guide
│   └── core-concepts/
│       ├── events.mdx           # Event tracking fundamentals
│       └── session-recording.mdx # Session replay configuration
└── api-reference/
    └── authentication.mdx        # API authentication guide

Development

Prerequisites

Install the Mintlify CLI:

npm i -g mint

Local Development

Run the development server:

mint dev

View your local preview at http://localhost:3000.

Making Changes

  1. Edit MDX files directly
  2. Changes are hot-reloaded in development
  3. Commit and push to deploy

Key Features Documented

Analytics SDK

  • Installation - NPM, CDN, and framework-specific setup
  • Event Tracking - Custom events with properties
  • User Identification - Link events to users
  • Session Recording - Capture and replay user sessions
  • Chrome Extensions - Specialized integration for browser extensions

Dashboard

  • Real-time analytics visualization
  • Session replay viewer
  • User profiles and segmentation
  • Custom reports and exports

API Reference

  • Authentication with public/secret keys
  • Event ingestion endpoints
  • Session data endpoints
  • User management APIs

Chrome Extension Focus

Special attention has been given to Chrome Extension integration with:

  • Manifest V3 support
  • Content script transport layer
  • Cross-context communication
  • Session recording in extensions
  • Bundle optimization strategies

Publishing Changes

Changes are automatically deployed to production after pushing to the default branch. The documentation is hosted at your configured Mintlify deployment URL.

Support

License

This documentation is proprietary to Composite Analytics.

Resources

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages