Interface Event

event tracking data structure

represents a user interaction or system event. used for analytics, personalization model training, and tracking user behavior across sessions.

interface Event {
    eventType: string;
    payload?: Record<string, any>;
    predictionIds?: string[];
    predictionId?: string;
    timestamp?: string;
    sessionId?: string | number;
    units?: Record<string, string>;
    value?: string;
}

Properties

eventType payload? predictionIds? predictionId? timestamp? sessionId? units? value?

Properties

eventType

eventType: string

event type name or uuid (e.g., "click", "purchase", "view")

Optionalpayload

payload?: Record<string, any>

event-specific payload data (e.g., { item_id: "123", price: 99.99 })

OptionalpredictionIds

predictionIds?: string[]

associated prediction uuids (when event follows predictions)

OptionalpredictionId

predictionId?: string

single associated prediction uuid

Optionaltimestamp

timestamp?: string

event timestamp in iso format (defaults to server time if not provided)

OptionalsessionId

sessionId?: string | number

session identifier (can be uuid, string, or number)

Optionalunits

units?: Record<string, string>

Deprecated

legacy field for units

Optionalvalue

value?: string

Deprecated

legacy field for value

Settings

Member Visibility

On This Page

Properties