Skip to content

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

Enhance analytics filters and queries for event tracking

Bill Yang357f37a4f4ef
diff --git a/client/src/lib/filterGroups.ts b/client/src/lib/filterGroups.ts
index 6aea22058..3265ad664 100644
--- a/client/src/lib/filterGroups.ts
+++ b/client/src/lib/filterGroups.ts
@@ -26,7 +26,7 @@ const BASE_FILTERS: FilterParameter[] = [
"lon",
];
-export const SESSION_PAGE_FILTERS: FilterParameter[] = [...BASE_FILTERS, "entry_page", "exit_page"];
+export const SESSION_PAGE_FILTERS: FilterParameter[] = [...BASE_FILTERS, "entry_page", "exit_page", "event_name"];
export const EVENT_FILTERS: FilterParameter[] = [
...BASE_FILTERS,
diff --git a/server/src/api/analytics/getOverview.ts b/server/src/api/analytics/getOverview.ts
index 320e8b881..fbde8dd7d 100644
--- a/server/src/api/analytics/getOverview.ts
+++ b/server/src/api/analytics/getOverview.ts
@@ -1,9 +1,8 @@
+import { FilterParams } from "@rybbit/shared";
import { FastifyReply, FastifyRequest } from "fastify";
import { clickhouse } from "../../db/clickhouse/clickhouse.js";
-import { getFilterStatement, getTimeStatement, processResults } from "./utils.js";
import { getUserHasAccessToSitePublic } from "../../lib/auth-utils.js";
-import { FilterParameter } from "./types.js";
-import { FilterParams } from "@rybbit/shared";
+import { getFilterStatement, getTimeStatement, processResults } from "./utils.js";
type GetOverviewResponse = {
sessions: number;
@@ -16,6 +15,7 @@ type GetOverviewResponse = {
const getQuery = (params: FilterParams) => {
const filterStatement = getFilterStatement(params.filters);
+ const timeStatement = getTimeStatement(params);
return `SELECT
session_stats.sessions,
@@ -44,7 +44,7 @@ const getQuery = (params: FilterParams) => {
WHERE
site_id = {siteId:Int32}
${filterStatement}
- ${getTimeStatement(params)}
+ ${timeStatement}
GROUP BY session_id
)
) AS session_stats
@@ -52,14 +52,14 @@ const getQuery = (params: FilterParams) => {
(
-- Page-level and user-level metrics
SELECT
- COUNT(*) AS pageviews,
+ COUNT(CASE WHEN type = 'pageview' THEN 1 END) AS pageviews,
COUNT(DISTINCT user_id) AS users
FROM events
WHERE
site_id = {siteId:Int32}
${filterStatement}
- ${getTimeStatement(params)}
- AND type = 'pageview'
+ ${timeStatement}
+ -- AND type = 'pageview'
) AS page_stats`;
};
diff --git a/server/src/api/analytics/getSingleCol.ts b/server/src/api/analytics/getSingleCol.ts
index b1cc8d7eb..dc56f0d78 100644
--- a/server/src/api/analytics/getSingleCol.ts
+++ b/server/src/api/analytics/getSingleCol.ts
@@ -48,8 +48,7 @@ type GetSingleColPaginatedResponse = {
};
const getQuery = (request: FastifyRequest<GetSingleColRequest>, isCountQuery: boolean = false) => {
- const { startDate, endDate, timeZone, filters, parameter, limit, page, pastMinutesStart, pastMinutesEnd } =
- request.query;
+ const { filters, parameter, limit, page } = request.query;
const filterStatement = getFilterStatement(filters);
const timeStatement = getTimeStatement(request.query);
@@ -117,7 +116,7 @@ const getQuery = (request: FastifyRequest<GetSingleColRequest>, isCountQuery: bo
site_id = {siteId:Int32}
AND page_title IS NOT NULL
AND page_title <> ''
- AND type = 'pageview'
+ -- AND type = 'pageview'
${filterStatement}
${timeStatement}
GROUP BY page_title
@@ -157,7 +156,7 @@ const getQuery = (request: FastifyRequest<GetSingleColRequest>, isCountQuery: bo
FROM events
WHERE
site_id = {siteId:Int32}
- AND type = 'pageview'
+ -- AND type = 'pageview'
${filterStatement}
${timeStatement}
),
@@ -230,7 +229,7 @@ const getQuery = (request: FastifyRequest<GetSingleColRequest>, isCountQuery: bo
FROM events
WHERE
site_id = {siteId:Int32}
- AND type = 'pageview'
+ -- AND type = 'pageview'
${filterStatement}
${timeStatement}
),
diff --git a/server/src/api/analytics/utils.ts b/server/src/api/analytics/utils.ts
index 2171c2f4d..b968adda8 100644
--- a/server/src/api/analytics/utils.ts
+++ b/server/src/api/analytics/utils.ts
@@ -157,6 +157,28 @@ export function getFilterStatement(filters: string) {
const x = filter.type === "contains" || filter.type === "not_contains" ? "%" : "";
const isNumericParam = filter.parameter === "lat" || filter.parameter === "lon";
+ // Handle event_name as a session-level filter
+ // This ensures we filter to sessions containing the event, but still count all pageviews in those sessions
+ if (filter.parameter === "event_name") {
+ if (filter.value.length === 1) {
+ return `session_id IN (
+ SELECT DISTINCT session_id
+ FROM events
+ WHERE event_name ${filterTypeToOperator(filter.type)} ${SqlString.escape(x + filter.value[0] + x)}
+ )`;
+ }
+
+ const valuesWithOperator = filter.value.map(
+ value => `event_name ${filterTypeToOperator(filter.type)} ${SqlString.escape(x + value + x)}`
+ );
+
+ return `session_id IN (
+ SELECT DISTINCT session_id
+ FROM events
+ WHERE (${valuesWithOperator.join(" OR ")})
+ )`;
+ }
+
if (filter.parameter === "entry_page") {
if (filter.value.length === 1) {
return `session_id IN (
diff --git a/server/src/db/clickhouse/clickhouse.ts b/server/src/db/clickhouse/clickhouse.ts
index f57d0a01b..555b3f211 100644
--- a/server/src/db/clickhouse/clickhouse.ts
+++ b/server/src/db/clickhouse/clickhouse.ts
@@ -36,7 +36,9 @@ export const initializeClickhouse = async () => {
screen_width UInt16,
screen_height UInt16,
device_type LowCardinality(String),
+ -- either 'pageview', 'custom_event', 'performance', 'outbound_link', 'error'
type LowCardinality(String) DEFAULT 'pageview',
+ -- only for custom_event
event_name String,
props JSON
)