Events API
Track user events and conversions.
Track Event
http
POST /v1/eventsRequest:
json
{
"event": "purchase_completed",
"userId": "user-123",
"timestamp": "2024-01-15T10:30:00Z",
"properties": {
"revenue": 99.99,
"currency": "USD",
"orderId": "order-456"
}
}Response:
json
{
"data": {
"id": "evt_789",
"status": "accepted"
}
}Batch Events
http
POST /v1/events/batchRequest:
json
{
"events": [
{
"event": "page_viewed",
"userId": "user-123",
"properties": { "page": "/pricing" }
},
{
"event": "button_clicked",
"userId": "user-123",
"properties": { "button": "signup" }
}
]
}Query Events
http
GET /v1/events?userId=user-123&event=purchase_completedQuery Parameters:
| Parameter | Type | Description |
|---|---|---|
userId | string | Filter by user |
event | string | Filter by event name |
from | ISO8601 | Start date |
to | ISO8601 | End date |
limit | number | Max results (default: 100) |
Event Schema
| Field | Type | Required | Description |
|---|---|---|---|
event | string | Yes | Event name |
userId | string | Yes | User identifier |
timestamp | ISO8601 | No | Event time (defaults to now) |
properties | object | No | Custom event data |
Reserved Properties
| Property | Type | Description |
|---|---|---|
revenue | number | Revenue amount |
currency | string | ISO currency code |
experimentId | string | Associated experiment |
variant | string | Experiment variant |