API Reference
Tracking
Record page views and custom events. Uses the site key for authentication.
Record a Visit
POST
/api/v1/tracking/visits
Site Key
30 req/min
Records a page visit and returns a visit token for associating subsequent events.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| referrer | string | No | HTTP referrer URL |
| landing_page | string | No | Landing page URL. UTM parameters are extracted automatically. |
Response
{
"visit_token": "abc123..."
}
Record an Event
POST
/api/v1/tracking/events
Site Key
60 req/min
Records a custom event, optionally associated with a visit.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Event name (max 100 characters) |
| properties | object | No | Custom properties (see constraints below) |
Properties Constraints
- Maximum total size: 4 KB
- Maximum keys: 50
- Maximum string value length: 500 characters
- Maximum array size: 20 items
- Maximum nesting depth: 3 levels
Response
{
"id": 42
}