Method getSankey

packages/db/src/services/sankey.service.ts:340–506

({
    projectId,
    startDate,
    endDate,
    steps = 5,
    mode,
    startEvent,
    endEvent,
    exclude = [],
    include,
    timezone,
  }: IGetSankeyInput)

  }

  async getSankey({
    projectId,
    startDate,
    endDate,
    steps = 5,
    mode,
    startEvent,
    endEvent,
    exclude = [],
    include,
    timezone,
  }: IGetSankeyInput): Promise<{
    nodes: Array<{
      id: string;
      label: string;
      nodeColor: string;
      percentage?: number;
      value?: number;
      step?: number;
    }>;
    links: Array<{ source: string; target: string; value: number }>;
  }> {
    const COLORS = chartColors.map((color) => color.main);

    // 1. Build event name filter
    const eventNameFilter = this.buildEventNameFilter(
      include,
      exclude,
      startEvent?.name,
      endEvent?.name,
    );

    // 2. Build ordered events query
    // For screen_view events, use the path instead of the event name for more meaningful flow visualization
    const orderedEventsQuery = clix(this.client, timezone)
      .select<{
        session_id: string;
        event_name: string;
        created_at: string;
      }>([
        'session_id',
        // "if(name = 'screen_view', path, name) as event_name",
        'name as event_name',
        'created_at',
      ])
      .from(TABLE_NAMES.events)
      .where('project_id', '=', projectId)
      .where('created_at', 'BETWEEN', [
        clix.datetime(startDate, 'toDateTime'),
        clix.datetime(endDate, 'toDateTime'),
      ])
      .orderBy('session_id', 'ASC')
      .orderBy('created_at', 'ASC');

    if (eventNameFilter) {
      orderedEventsQuery.rawWhere(eventNameFilter);
    }