umami/src/queries/analytics/reports/getUTM.ts

import clickhouse from 'lib/clickhouse';
import { CLICKHOUSE, PRISMA, runQuery } from 'lib/db';
import prisma from 'lib/prisma';
import { safeDecodeURIComponent } from 'next-basics';

export async function getUTM(
  ...args: [
    websiteId: string,
    filters: {
      startDate: Date;
      endDate: Date;
      timezone?: string;
    },
  ]
) {
  return runQuery({
    [PRISMA]: () => relationalQuery(...args),
    [CLICKHOUSE]: () => clickhouseQuery(...args),
  });
}

async function relationalQuery(
  websiteId: string,
  filters: {
    startDate: Date;
    endDate: Date;
    timezone?: string;
  },
): Promise<
  {
    date: string;
    day: number;
    visitors: number;
    returnVisitors: number;
    percentage: number;
  }[]
> {
  const { startDate, endDate } = filters;
  const { rawQuery } = prisma;

  return rawQuery(
    `
    select url_query, count(*) as "num"
    from website_event
    where website_id = {{websiteId::uuid}}
      and created_at between {{startDate}} and {{endDate}}
      and url_query is not null
    group by 1
    `,
    {
      websiteId,
      startDate,
      endDate,
    },
  ).then(results => {
    return results;
  });
}

async function clickhouseQuery(
  websiteId: string,
  filters: {
    startDate: Date;
    endDate: Date;
    timezone?: string;
  },
): Promise<
  {
    date: string;
    day: number;
    visitors: number;
    returnVisitors: number;
    percentage: number;
  }[]
> {
  const { startDate, endDate } = filters;
  const { rawQuery } = clickhouse;

  return rawQuery(
    `
    select url_query, count(*) as "num"
    from website_event
    where website_id = {websiteId:UUID}
      and created_at between {startDate:DateTime64} and {endDate:DateTime64}
      and url_query != ''
    group by 1
    `,
    {
      websiteId,
      startDate,
      endDate,
    },
  ).then(result => parseParameters(result as any[]));
}

function parseParameters(data: any[]) {
  return data.reduce((obj, { url_query, num }) => {
    try {
      const searchParams = new URLSearchParams(url_query);

      for (const [key, value] of searchParams) {
        if (key.match(/^utm_(\w+)$/)) {
          const name = safeDecodeURIComponent(value);
          if (!obj[key]) {
            obj[key] = { [name]: +num };
          } else if (!obj[key][name]) {
            obj[key][name] = +num;
          } else {
            obj[key][name] += +num;
          }
        }
      }
    } catch {
      // Ignore
    }

    return obj;
  }, {});
}