Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

1.7 KB
Raw Blame
export interface SessionReplayEvent {
  siteId: number;
  sessionId: string;
  userId: string;
  identifiedUserId?: string;
  timestamp: Date;
  eventType: string;
  eventData: string;
  sequenceNumber: number;
  eventSizeBytes: number;
  viewportWidth?: number;
  viewportHeight?: number;
  isComplete: boolean;
}

export interface SessionReplayMetadata {
  siteId: number;
  sessionId: string;
  userId: string;
  identifiedUserId?: string;
  startTime: Date;
  endTime?: Date;
  durationMs?: number;
  eventCount: number;
  compressedSizeBytes: number;
  pageUrl: string;
  country: string;
  region: string;
  city: string;
  lat: number;
  lon: number;
  browser: string;
  browserVersion: string;
  operatingSystem: string;
  operatingSystemVersion: string;
  language: string;
  screenWidth: number;
  screenHeight: number;
  deviceType: string;
  channel: string;
  hostname: string;
  referrer: string;
  hasReplayData: boolean;
  recordingStatus: "recording" | "completed" | "failed";
  createdAt: Date;
}

export interface RecordSessionReplayRequest {
  userId: string;
  events: Array<{
    type: string | number;
    data: any;
    timestamp: number;
  }>;
  metadata?: {
    pageUrl: string;
    viewportWidth?: number;
    viewportHeight?: number;
    language?: string;
  };
  apiKey?: string;
}

export interface SessionReplayListItem {
  sessionId: string;
  userId: string;
  identifiedUserId?: string;
  startTime: Date;
  endTime?: Date;
  durationMs?: number;
  pageUrl: string;
  eventCount: number;
  recordingStatus: string;
  country: string;
  browser: string;
  deviceType: string;
}

export interface GetSessionReplayEventsResponse {
  events: Array<{
    timestamp: number;
    type: string;
    data: any;
  }>;
  metadata: SessionReplayMetadata;
}