Events API
Track custom events and query them via the API.Track Event
Request
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Event name (e.g., user.signup) |
timestamp | string | No | ISO8601 timestamp (defaults to now) |
user_id | string | No | Associated user identifier |
value | number | No | Numeric value for aggregations |
properties | object | No | Arbitrary event data |
tags | object | No | Indexed metadata for filtering |
Response
Batch Track
Send multiple events in one request:Request
Response
List Events
Query events with filters:Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Filter by event name (exact or prefix with *) |
from | string | Start timestamp (ISO8601) |
to | string | End timestamp (ISO8601) |
user_id | string | Filter by user |
tags[key] | string | Filter by tag value |
limit | integer | Max results (default: 100, max: 1000) |
offset | integer | Pagination offset |
Request
Response
Count Events
Get event counts:Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Event name filter |
from | string | Start timestamp |
to | string | End timestamp |
interval | string | Group by interval (1m, 5m, 1h, 1d) |
group_by | string | Group by tag key |
Request
Response
Group By
Event Stats
Get aggregated statistics for events with values:Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Event name |
field | string | Field to aggregate (default: value) |
from | string | Start timestamp |
to | string | End timestamp |
Request
Response
Rate Limits
- Single event: Standard rate limit
- Batch: 10 requests/minute, up to 500 events per request
- Query: 60 requests/minute
Errors
| Code | Description |
|---|---|
missing_name | Event name is required |
invalid_timestamp | Timestamp format invalid |
batch_too_large | Batch exceeds 500 events |
invalid_tags | Tags must be string values |