aboutsummaryrefslogtreecommitdiff
path: root/src/queries/sql/pageviews/getPageviewMetrics.ts
diff options
context:
space:
mode:
authorFuwn <[email protected]>2026-01-24 13:09:50 +0000
committerFuwn <[email protected]>2026-01-24 13:09:50 +0000
commit396acf3bbbe00a192cb0ea0a9ccf91b1d8d2850b (patch)
treeb9df4ca6a70db45cfffbae6fdd7252e20fb8e93c /src/queries/sql/pageviews/getPageviewMetrics.ts
downloadumami-396acf3bbbe00a192cb0ea0a9ccf91b1d8d2850b.tar.xz
umami-396acf3bbbe00a192cb0ea0a9ccf91b1d8d2850b.zip
Initial commitHEADmain
Created from https://vercel.com/new
Diffstat (limited to 'src/queries/sql/pageviews/getPageviewMetrics.ts')
-rw-r--r--src/queries/sql/pageviews/getPageviewMetrics.ts191
1 files changed, 191 insertions, 0 deletions
diff --git a/src/queries/sql/pageviews/getPageviewMetrics.ts b/src/queries/sql/pageviews/getPageviewMetrics.ts
new file mode 100644
index 0000000..9d4f627
--- /dev/null
+++ b/src/queries/sql/pageviews/getPageviewMetrics.ts
@@ -0,0 +1,191 @@
+import clickhouse from '@/lib/clickhouse';
+import { EVENT_COLUMNS, FILTER_COLUMNS, SESSION_COLUMNS } from '@/lib/constants';
+import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
+import prisma from '@/lib/prisma';
+import type { QueryFilters } from '@/lib/types';
+
+const FUNCTION_NAME = 'getPageviewMetrics';
+
+export interface PageviewMetricsParameters {
+ type: string;
+ limit?: number | string;
+ offset?: number | string;
+}
+
+export interface PageviewMetricsData {
+ x: string;
+ y: number;
+}
+
+export async function getPageviewMetrics(
+ ...args: [websiteId: string, parameters: PageviewMetricsParameters, filters: QueryFilters]
+) {
+ return runQuery({
+ [PRISMA]: () => relationalQuery(...args),
+ [CLICKHOUSE]: () => clickhouseQuery(...args),
+ });
+}
+
+async function relationalQuery(
+ websiteId: string,
+ parameters: PageviewMetricsParameters,
+ filters: QueryFilters,
+): Promise<PageviewMetricsData[]> {
+ const { type, limit = 500, offset = 0 } = parameters;
+ let column = FILTER_COLUMNS[type] || type;
+ const { rawQuery, parseFilters } = prisma;
+ const { filterQuery, joinSessionQuery, cohortQuery, queryParams } = parseFilters(
+ {
+ ...filters,
+ websiteId,
+ },
+ { joinSession: SESSION_COLUMNS.includes(type) },
+ );
+
+ let entryExitQuery = '';
+ let excludeDomain = '';
+
+ if (column === 'referrer_domain') {
+ excludeDomain = `and website_event.referrer_domain != website_event.hostname
+ and website_event.referrer_domain != ''`;
+ }
+
+ if (type === 'entry' || type === 'exit') {
+ const order = type === 'entry' ? 'asc' : 'desc';
+ column = `x.${column}`;
+
+ entryExitQuery = `
+ join (
+ select distinct on (visit_id)
+ visit_id,
+ url_path
+ from website_event
+ where website_event.website_id = {{websiteId::uuid}}
+ and website_event.created_at between {{startDate}} and {{endDate}}
+ and website_event.event_type != 2
+ order by visit_id, created_at ${order}
+ ) x
+ on x.visit_id = website_event.visit_id
+ `;
+ }
+
+ return rawQuery(
+ `
+ select ${column} x,
+ count(distinct website_event.session_id) as y
+ from website_event
+ ${cohortQuery}
+ ${joinSessionQuery}
+ ${entryExitQuery}
+ where website_event.website_id = {{websiteId::uuid}}
+ and website_event.created_at between {{startDate}} and {{endDate}}
+ and website_event.event_type != 2
+ ${excludeDomain}
+ ${filterQuery}
+ group by 1
+ order by 2 desc
+ limit ${limit}
+ offset ${offset}
+ `,
+ { ...queryParams, ...parameters },
+ FUNCTION_NAME,
+ );
+}
+
+async function clickhouseQuery(
+ websiteId: string,
+ parameters: PageviewMetricsParameters,
+ filters: QueryFilters,
+): Promise<{ x: string; y: number }[]> {
+ const { type, limit = 500, offset = 0 } = parameters;
+ let column = FILTER_COLUMNS[type] || type;
+ const { rawQuery, parseFilters } = clickhouse;
+ const { filterQuery, cohortQuery, queryParams } = parseFilters({
+ ...filters,
+ websiteId,
+ });
+
+ let sql = '';
+ let excludeDomain = '';
+
+ if (EVENT_COLUMNS.some(item => Object.keys(filters).includes(item))) {
+ let entryExitQuery = '';
+
+ if (column === 'referrer_domain') {
+ excludeDomain = `and referrer_domain != hostname and referrer_domain != ''`;
+ }
+
+ if (type === 'entry' || type === 'exit') {
+ const aggregrate = type === 'entry' ? 'argMin' : 'argMax';
+ column = `x.${column}`;
+
+ entryExitQuery = `
+ JOIN (select visit_id,
+ ${aggregrate}(url_path, created_at) url_path
+ from website_event
+ where website_id = {websiteId:UUID}
+ and created_at between {startDate:DateTime64} and {endDate:DateTime64}
+ and event_type != 2
+ group by visit_id) x
+ ON x.visit_id = website_event.visit_id`;
+ }
+
+ sql = `
+ select ${column} x,
+ uniq(website_event.session_id) as y
+ from website_event
+ ${cohortQuery}
+ ${entryExitQuery}
+ where website_id = {websiteId:UUID}
+ and created_at between {startDate:DateTime64} and {endDate:DateTime64}
+ and event_type != 2
+ ${excludeDomain}
+ ${filterQuery}
+ group by x
+ order by y desc
+ limit ${limit}
+ offset ${offset}
+ `;
+ } else {
+ let groupByQuery = '';
+ let columnQuery = `arrayJoin(${column})`;
+
+ if (column === 'referrer_domain') {
+ excludeDomain = `and t != ''`;
+ }
+
+ if (type === 'entry') {
+ columnQuery = `argMinMerge(entry_url)`;
+ }
+
+ if (type === 'exit') {
+ columnQuery = `argMaxMerge(exit_url)`;
+ }
+
+ if (type === 'entry' || type === 'exit') {
+ groupByQuery = 'group by s';
+ }
+
+ sql = `
+ select g.t as x,
+ uniq(s) as y
+ from (
+ select session_id s,
+ ${columnQuery} as t
+ from website_event_stats_hourly as website_event
+ ${cohortQuery}
+ where website_id = {websiteId:UUID}
+ and created_at between {startDate:DateTime64} and {endDate:DateTime64}
+ and event_type != 2
+ ${excludeDomain}
+ ${filterQuery}
+ ${groupByQuery}) as g
+ group by x
+ order by y desc
+ limit ${limit}
+ offset ${offset}
+ `;
+ }
+
+ return rawQuery(sql, { ...queryParams, ...parameters }, FUNCTION_NAME);
+}