@siteline/core
v1.0.1
Published
Core tracking SDK for Siteline - Agent Analytics platform for tracking AI agents, bots, and crawlers
Readme
@siteline/core
Core Siteline tracking SDK for monitoring AI agents, bots, and crawlers across your web applications.
Features
- Track bots from OpenAI, Google, Anthropic, Perplexity, and more
- Full TypeScript support with exported types
- Works in Node.js, Edge runtimes, and browsers
- Automatic data sanitization and validation
Installation
npm install @siteline/coreQuick Start
import { Siteline } from '@siteline/core';
const siteline = new Siteline({
websiteKey: 'siteline_secret_xxxxxxxxxxxxxxxxxxxxxxxxxxxx',
});
siteline.track({
url: '/api/users',
method: 'GET',
status: 200,
duration: 125,
userAgent: request.headers['user-agent'],
ref: request.headers['referer'],
ip: request.ip,
});API Reference
Constructor
new Siteline(config: SitelineConfig)Configuration Options:
| Option | Type | Required | Description |
|--------|------|----------|-------------|
| websiteKey | string | Yes | Your Siteline website key |
| endpoint | string | No | Custom API endpoint (default: https://api.siteline.ai/v1/intake/pageview) |
| debug | boolean | No | Enable debug logging (default: false) |
track()
siteline.track(data: PageviewData)Pageview Data:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| url | string | Yes | Request URL path |
| method | string | Yes | HTTP method |
| status | number | Yes | HTTP status code |
| duration | number | Yes | Request duration in milliseconds |
| userAgent | string \| null | Yes | User-Agent header |
| ref | string \| null | Yes | Referer header |
| ip | string \| null | Yes | Client IP address |
Framework Integrations
For framework-specific integrations with automatic tracking:
- @siteline/nextjs - Next.js middleware integration
Documentation
Support
License
MIT
