Skip to content

armgit / umami

Public Imported from GitHub
0

Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.

Added query options.

Mike Cao688705dbb3eb
diff --git a/lib/prisma.ts b/lib/prisma.ts
index d1b9d0e5d..0125e7f35 100644
--- a/lib/prisma.ts
+++ b/lib/prisma.ts
@@ -4,7 +4,7 @@ import { MYSQL, POSTGRESQL, getDatabaseType } from 'lib/db';
import { FILTER_COLUMNS, IGNORED_FILTERS, SESSION_COLUMNS } from './constants';
import { loadWebsite } from './load';
import { maxDate } from './date';
-import { QueryFilters } from './types';
+import { QueryFilters, QueryOptions } from './types';
const MYSQL_DATE_FORMATS = {
minute: '%Y-%m-%d %H:%i:00',
@@ -88,13 +88,18 @@ function getFilterQuery(filters = {}): string {
return query.join('\n');
}
-async function parseFilters(websiteId, filters: QueryFilters & { [key: string]: any } = {}) {
+async function parseFilters(
+ websiteId,
+ filters: QueryFilters & { [key: string]: any } = {},
+ options: QueryOptions = {},
+) {
const website = await loadWebsite(websiteId);
return {
- joinSession: Object.keys(filters).find(key => SESSION_COLUMNS[key])
- ? `inner join session on website_event.session_id = session.session_id`
- : '',
+ joinSession:
+ options?.joinSession || Object.keys(filters).find(key => SESSION_COLUMNS.includes(key))
+ ? `inner join session on website_event.session_id = session.session_id`
+ : '',
filterQuery: getFilterQuery(filters),
params: {
...filters,
diff --git a/lib/types.ts b/lib/types.ts
index 131740f88..3ce852aec 100644
--- a/lib/types.ts
+++ b/lib/types.ts
@@ -137,11 +137,11 @@ export interface QueryFilters {
unit?: string;
domain?: string;
eventType?: number;
+ eventName?: string;
url?: string;
referrer?: string;
title?: string;
query?: string;
- event?: string;
os?: string;
browser?: string;
device?: string;
@@ -150,3 +150,7 @@ export interface QueryFilters {
city?: string;
language?: string;
}
+
+export interface QueryOptions {
+ joinSession?: boolean;
+}
diff --git a/pages/api/websites/[id]/events.ts b/pages/api/websites/[id]/events.ts
index b9e3ac71c..7d4f999f6 100644
--- a/pages/api/websites/[id]/events.ts
+++ b/pages/api/websites/[id]/events.ts
@@ -43,10 +43,8 @@ export default async (
endDate,
timezone,
unit,
- filters: {
- url,
- eventName,
- },
+ url,
+ eventName,
});
return ok(res, events);
diff --git a/queries/analytics/events/getEventMetrics.ts b/queries/analytics/events/getEventMetrics.ts
index cf862f4a7..09a859461 100644
--- a/queries/analytics/events/getEventMetrics.ts
+++ b/queries/analytics/events/getEventMetrics.ts
@@ -5,7 +5,7 @@ import { WebsiteEventMetric, QueryFilters } from 'lib/types';
import { EVENT_TYPE } from 'lib/constants';
export async function getEventMetrics(
- ...args: [websiteId: string, criteria: QueryFilters]
+ ...args: [websiteId: string, filters: QueryFilters]
): Promise<WebsiteEventMetric[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
@@ -16,7 +16,7 @@ export async function getEventMetrics(
async function relationalQuery(websiteId: string, filters: QueryFilters) {
const { timezone = 'utc', unit = 'day' } = filters;
const { rawQuery, getDateQuery, parseFilters } = prisma;
- const { filterQuery, params } = await parseFilters(websiteId, {
+ const { filterQuery, joinSession, params } = await parseFilters(websiteId, {
...filters,
eventType: EVENT_TYPE.customEvent,
});
@@ -28,6 +28,7 @@ async function relationalQuery(websiteId: string, filters: QueryFilters) {
${getDateQuery('created_at', unit, timezone)} t,
count(*) y
from website_event
+ ${joinSession}
where website_id = {{websiteId::uuid}}
and created_at between {{startDate}} and {{endDate}}
and event_type = {{eventType}}
diff --git a/queries/analytics/pageviews/getPageviewMetrics.ts b/queries/analytics/pageviews/getPageviewMetrics.ts
index bbbd77052..b365d3f6b 100644
--- a/queries/analytics/pageviews/getPageviewMetrics.ts
+++ b/queries/analytics/pageviews/getPageviewMetrics.ts
@@ -1,7 +1,7 @@
import prisma from 'lib/prisma';
import clickhouse from 'lib/clickhouse';
import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
-import { EVENT_TYPE } from 'lib/constants';
+import { EVENT_TYPE, SESSION_COLUMNS } from 'lib/constants';
import { QueryFilters } from 'lib/types';
export async function getPageviewMetrics(
@@ -15,16 +15,20 @@ export async function getPageviewMetrics(
async function relationalQuery(websiteId: string, column: string, filters: QueryFilters) {
const { rawQuery, parseFilters } = prisma;
- const { filterQuery, joinSession, params } = await parseFilters(websiteId, {
- ...filters,
- eventType: column === 'event_name' ? EVENT_TYPE.customEvent : EVENT_TYPE.pageView,
- });
+ const { filterQuery, joinSession, params } = await parseFilters(
+ websiteId,
+ {
+ ...filters,
+ eventType: column === 'event_name' ? EVENT_TYPE.customEvent : EVENT_TYPE.pageView,
+ },
+ { joinSession: SESSION_COLUMNS.includes(column) },
+ );
return rawQuery(
`
select ${column} x, count(*) y
from website_event
- ${joinSession}
+ ${joinSession}
where website_event.website_id = {{websiteId::uuid}}
and website_event.created_at between {{startDate}} and {{endDate}}
and event_type = {{eventType}}
diff --git a/queries/analytics/sessions/getSessionMetrics.ts b/queries/analytics/sessions/getSessionMetrics.ts
index f9bc2e942..fb546a73a 100644
--- a/queries/analytics/sessions/getSessionMetrics.ts
+++ b/queries/analytics/sessions/getSessionMetrics.ts
@@ -1,7 +1,7 @@
import prisma from 'lib/prisma';
import clickhouse from 'lib/clickhouse';
import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
-import { EVENT_TYPE } from 'lib/constants';
+import { EVENT_TYPE, SESSION_COLUMNS } from 'lib/constants';
import { QueryFilters } from 'lib/types';
export async function getSessionMetrics(
@@ -15,17 +15,22 @@ export async function getSessionMetrics(
async function relationalQuery(websiteId: string, column: string, filters: QueryFilters) {
const { parseFilters, rawQuery } = prisma;
- const { filterQuery, params } = await parseFilters(websiteId, {
- ...filters,
- eventType: EVENT_TYPE.pageView,
- });
+ const { filterQuery, joinSession, params } = await parseFilters(
+ websiteId,
+ {
+ ...filters,
+ eventType: EVENT_TYPE.pageView,
+ },
+ {
+ joinSession: SESSION_COLUMNS.includes(column),
+ },
+ );
return rawQuery(
`
select ${column} x, count(*) y
from website_event
- inner join session
- on session.session_id = website_event.session_id
+ ${joinSession}
where website_event.website_id = {{websiteId::uuid}}
and website_event.created_at between {{startDate}} and {{endDate}}
and website_event.event_type = {{eventType}}