@scope-analytics/browser
v0.0.5
Published
Build-time integration for Scope Analytics - Zero-code analytics with AI insights
Maintainers
Readme
Scope Analytics
Zero-code analytics with AI-powered insights. Install analytics in under 5 minutes without modifying your application code.
Installation
# Run after building your application
npx @scope-analytics/browser install --key YOUR_PUBLIC_KEY
# Or use environment variable
export SCOPE_PUBLIC_KEY=your_public_key
npx @scope-analytics/browser installHow it Works
Scope Analytics modifies your built HTML files to inject our lightweight SDK. This approach:
- ✅ Works with any framework or build tool
- ✅ No code changes required
- ✅ Automatic tracking of all user interactions
- ✅ Compatible with all major hosting platforms
Platform-Specific Setup
Vercel
// vercel.json
{
"buildCommand": "npm run build && npx @scope-analytics/browser install"
}Netlify
# netlify.toml
[build]
command = "npm run build && npx @scope-analytics/browser install"Render
Set build command: npm run build && npx @scope-analytics/browser install
Next.js
// package.json
{
"scripts": {
"build": "next build && npx @scope-analytics/browser install --dir .next"
}
}Commands
Install
npx @scope-analytics/browser install [options]
Options:
-k, --key <apiKey> Your Scope Analytics public key
-d, --dir <directory> Build output directory (default: dist)
-e, --endpoint <url> Custom API endpoint
--trusted-origins <origins> Comma-separated API origins that should receive the
session header when your API is on a different origin,
e.g. https://api.myapp.com (exact origins, no wildcards;
also via SCOPE_TRUSTED_ORIGINS env var)
--no-api-tracking Disable API call tracking
--debug Enable debug modeCross-origin APIs: by default the SDK attaches
X-Scope-Session-IDonly to same-origin requests.--trusted-originsextends that to the exact API origins you list — and your API's CORS must allow theX-Scope-Session-ID/X-Scope-Anonymous-IDheaders (cross-origin custom headers trigger a preflight), so configure both sides together.
Uninstall
npx @scope-analytics/browser uninstall [options]
Options:
-d, --dir <directory> Build output directory (default: dist)Validate
npx @scope-analytics/browser validate [options]
Options:
-d, --dir <directory> Build output directory (default: dist)What Gets Tracked
- 📊 Page views and navigation
- 🖱️ Clicks and interactions
- 📜 Scroll behavior and reading time
- ⏱️ Performance metrics
- 🔗 API calls (optional)
- ❌ Errors and exceptions
Features
- AI-Powered Insights: Ask questions in natural language
- Automatic Tracking: No manual event setup required
- Privacy-First: No personal data collection
- Lightweight: < 30KB gzipped
- Real-Time: See events as they happen
Support
- Documentation: Coming soon at https://scopeai.dev
- Email: Contact via https://scopeai.dev
- Issues: Please report issues via our website
License
MIT
