Skip to content

Events API

Track user events and conversions.

Track Event

http
POST /v1/events

Request:

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/batch

Request:

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_completed

Query Parameters:

ParameterTypeDescription
userIdstringFilter by user
eventstringFilter by event name
fromISO8601Start date
toISO8601End date
limitnumberMax results (default: 100)

Event Schema

FieldTypeRequiredDescription
eventstringYesEvent name
userIdstringYesUser identifier
timestampISO8601NoEvent time (defaults to now)
propertiesobjectNoCustom event data

Reserved Properties

PropertyTypeDescription
revenuenumberRevenue amount
currencystringISO currency code
experimentIdstringAssociated experiment
variantstringExperiment variant

Built with VitePress