Event Reference

Canonical Shared Event Schema

All domain-specific events include this shared base along with domain-specific extensions.

interface AnalyticsEvent {
  // Shared identifiers & timing
  
  /**
   * The difference between the client clock vs. server clock,
   * represented in milliseconds.
   */
  clockDriftInMs: number;
  /**
   * ISO 8601 timestamp from client clock, representing the timestamp
   * when the event was fired.
   */
  eventDate: string;
  /**
   * Universally unique event id, in UUID v4 format.
   */
  eventId: string;
  /**
   * The distinct, domain-specific type of event.
   */
  eventType: string;
  /**
   * The current visitor's locale setting in a multi-language environment.
   */
  locale?: string;
  /**
   * Distinct store identifier in a multi-store/multi-region environment.
   */
  storeRef?: string;
  /**
   * The distinct visitor identifier, if provided by the host app or
   * environment.
   */
  visitorExternalId?: string;
  /**
   * The universally, LiSA-assigned visitor identifier,
   * in UUID v4 format.
   */
  visitorId?: string;
  /**
   * The universally, LiSA-assigned visitor session identifier,
   * in UUID v4 format.
   */
  visitorSessionId?: string;

  // If applicable to the event
  
  /**
   * The universally unique identifier of the media item,
   * this event is associated with, in UUID v4 format.
   */
  mediaItemId?: string;
  /**
   * The distinct type of media item, this event is associated with.
   */
  mediaItemType?: 'live' | 'replay' | 'story';
  /**
   * An object, representing the current media item's playback progress.
   */
  progress?: {
    /**
     * Indicates, whether the current media item is a live stream or
     * recorded.
     */
    isLive: boolean;
    /**
     * Indicates whether the current media item playback is active.
     */
    isPlaying: boolean;
    /**
     * The current media item's playback position,
     * represented in milliseconds.
     */
    currentTimeInMs: number;
    /**
     * The current media item's total duration (-1 for live),
     * represented in milliseconds.
     */
    durationInMs: number;
    /**
     * The accumulated watch time, represented in milliseconds.
     */
    elapsedTimeInMs: number;
  };
}

Domain-specific events (e.g., product clicks) augment this with their own fields; those go into contextData as well or into commerce-specific variables when appropriate.

Events

Event Type	Description
lsc:comments:audience:join	Visitor joins the chat during a live stream.
lsc:comments:audience:comment	Visitor adds a comment during a live stream.
lsc:media:complete	Playback of the current media item has ended.
lsc:media:emoji	Visitor reacted to the media item with an emoji.
lsc:media:impression	Visitor opened the media item.
lsc:media:pause	Playback of the current media item has paused.
lsc:media:play	Playback of the current media item started.
lsc:media:resume	Playback of the current media item resumed.
lsc:product:add-to-cart	Visitor added a product to their cart.
lsc:product:add-to-wishlist	Visitor added a product to their wishlist.
lsc:product:click	Visitor clicked a product to see the product details.
lsc:product:emoji	Visitor reacted to the product with an emoji.
lsc:product:impression	Product card appeared in the visitor's viewport for the first time.
lsc:share:cancel	Visitor cancelled social sharing through their device's native sharing options.
lsc:share:click	Visitor clicked a social sharing target CTA.
lsc:share:complete	Visitor completed social sharing through their device's native sharing options.
lsc:sticker:click	Visitor clicked a sticker.
lsc:sticker:impression	Sticker appeared in the visitor's viewport for the first time.
lsc:sticker:poll:vote	Visitor submitted their vote on a poll sticker.
lsc:sticker:voucher:claim	Visitor claimed the voucher code from a voucher sticker.