Skip to content

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

fix(goals): honor page filters and first non-empty UTM attribution (#1177)

Mohd Irshad17bcab77421f
diff --git a/client/src/api/analytics/hooks/goals/useGetGoalSessions.ts b/client/src/api/analytics/hooks/goals/useGetGoalSessions.ts
index 94c75d1c2..15cabf8b1 100644
--- a/client/src/api/analytics/hooks/goals/useGetGoalSessions.ts
+++ b/client/src/api/analytics/hooks/goals/useGetGoalSessions.ts
@@ -1,4 +1,6 @@
import { Time } from "../../../../components/DateSelector/types";
+import { GOALS_PAGE_FILTERS } from "../../../../lib/filterGroups";
+import { getFilteredFilters } from "../../../../lib/store";
import { GetSessionsResponse } from "../../endpoints";
import { useAnalyticsQuery } from "../../useAnalyticsQuery";
@@ -17,12 +19,15 @@ export function useGetGoalSessions({
limit?: number;
enabled?: boolean;
}) {
+ const filteredFilters = getFilteredFilters(GOALS_PAGE_FILTERS);
+
return useAnalyticsQuery<GetSessionsResponse>({
key: ["goal-sessions", goalId],
path: `goals/${goalId}/sessions`,
site: siteId,
overrideTime: time,
- useFilters: false,
+ useFilters: filteredFilters.length > 0,
+ customFilters: filteredFilters,
params: { page, limit },
enabled: !!goalId && enabled,
});
diff --git a/server/src/api/analytics/goals/getGoalSessions.ts b/server/src/api/analytics/goals/getGoalSessions.ts
index 43cd8c2f2..a7b9901a4 100644
--- a/server/src/api/analytics/goals/getGoalSessions.ts
+++ b/server/src/api/analytics/goals/getGoalSessions.ts
@@ -6,6 +6,7 @@ import { getTimeStatement } from "../utils/timeWindow.js";
import { FilterParams } from "@rybbit/shared";
import { GetSessionsResponse } from "../sessions/getSessions.js";
import { analyticsRoute, runAnalyticsQuery } from "../utils/analyticsQuery.js";
+import { goalSessionUtmAgg } from "../utils/sessionAttribution.js";
import { buildFilteredSessionsCTE } from "../utils/sessionFilters.js";
import { buildGoalCondition } from "./goalConditions.js";
@@ -61,11 +62,11 @@ export const buildGoalSessionsQuery = (
argMin(e.hostname, e.timestamp) AS hostname,
argMin(e.page_title, e.timestamp) AS page_title,
argMin(e.querystring, e.timestamp) AS querystring,
- argMin(e.url_parameters, e.timestamp)['utm_source'] AS utm_source,
- argMin(e.url_parameters, e.timestamp)['utm_medium'] AS utm_medium,
- argMin(e.url_parameters, e.timestamp)['utm_campaign'] AS utm_campaign,
- argMin(e.url_parameters, e.timestamp)['utm_term'] AS utm_term,
- argMin(e.url_parameters, e.timestamp)['utm_content'] AS utm_content,
+ ${goalSessionUtmAgg("utm_source")} AS utm_source,
+ ${goalSessionUtmAgg("utm_medium")} AS utm_medium,
+ ${goalSessionUtmAgg("utm_campaign")} AS utm_campaign,
+ ${goalSessionUtmAgg("utm_term")} AS utm_term,
+ ${goalSessionUtmAgg("utm_content")} AS utm_content,
MAX(e.timestamp) AS session_end,
MIN(e.timestamp) AS session_start,
dateDiff('second', MIN(e.timestamp), MAX(e.timestamp)) AS session_duration,
diff --git a/server/src/api/analytics/goals/goalQueries.test.ts b/server/src/api/analytics/goals/goalQueries.test.ts
index ce5dd4f3e..797c58ebb 100644
--- a/server/src/api/analytics/goals/goalQueries.test.ts
+++ b/server/src/api/analytics/goals/goalQueries.test.ts
@@ -34,7 +34,7 @@ describe("goal queries with global session filters", () => {
const sql = buildGoalsConversionsQuery(query, 1, [formGoal] as any);
expect(sql).toContain("FilteredSessions AS");
- expect(sql).toContain("argMin(url_parameters, timestamp)['utm_campaign'] AS utm_campaign");
+ expect(sql).toContain("argMinIf(url_parameters['utm_campaign'], timestamp, url_parameters['utm_campaign'] != '') AS utm_campaign");
expect(sql).toContain("WHERE 1 = 1 AND utm_campaign = 'recipe_book_2026'");
expect(sql).toContain("INNER JOIN FilteredSessions USING (session_id)");
expect(sql).toContain("type = 'form_submit'");
@@ -56,7 +56,7 @@ describe("goal queries with global session filters", () => {
expect(sql).toContain("type = 'form_submit'");
});
- it("applies the campaign filter to the expanded converted-sessions list", () => {
+ it("uses the same campaign-qualified sessions for the expanded converted-sessions list", () => {
const sql = buildGoalSessionsQuery(
{ ...query, page: 1, limit: 25 },
1,
@@ -67,4 +67,13 @@ describe("goal queries with global session filters", () => {
expect(sql).toContain("WHERE 1 = 1 AND utm_campaign = 'recipe_book_2026'");
expect(sql).toContain("INNER JOIN FilteredSessions USING (session_id)");
});
+
+ it("qualifies sessions by the first non-empty utm_medium value", () => {
+ const mediumFilter = JSON.stringify([{ parameter: "utm_medium", type: "equals", value: ["search"] }]);
+ const sql = buildGoalsConversionsQuery({ ...query, filters: mediumFilter }, 1, [formGoal] as any);
+
+ expect(sql).toContain("argMinIf(url_parameters['utm_medium'], timestamp, url_parameters['utm_medium'] != '') AS utm_medium");
+ expect(sql).toContain("WHERE 1 = 1 AND utm_medium = 'search'");
+ expect(sql).toContain("INNER JOIN FilteredSessions USING (session_id)");
+ });
});
diff --git a/server/src/api/analytics/sessions/getSessions.filters.test.ts b/server/src/api/analytics/sessions/getSessions.filters.test.ts
new file mode 100644
index 000000000..92509a602
--- /dev/null
+++ b/server/src/api/analytics/sessions/getSessions.filters.test.ts
@@ -0,0 +1,32 @@
+import { describe, expect, it, vi } from "vitest";
+
+vi.mock("../../../db/clickhouse/clickhouse.js", () => ({
+ clickhouse: { query: vi.fn() },
+}));
+vi.mock("../../../db/postgres/postgres.js", () => ({
+ db: {},
+}));
+
+import { buildSessionsQuery } from "../sessions/getSessions.js";
+
+describe("buildSessionsQuery with user and event_name filters", () => {
+ it("should scope sessions to the user while filtering by event_name via subquery", () => {
+ const { query } = buildSessionsQuery(
+ {
+ filters: JSON.stringify([{ parameter: "event_name", type: "equals", value: ["sale"] }]),
+ page: 1,
+ limit: 100,
+ user_id: "e7d1e46a0b1b6209df4b6420030469a3afbd33a9b66a647fd6bf5e3cb9c51099",
+ start_date: "",
+ end_date: "",
+ time_zone: "UTC",
+ },
+ 1
+ );
+
+ expect(query).toContain("session_id IN");
+ expect(query).toContain("event_name = 'sale'");
+ expect(query).toContain("identified_user_id");
+ expect(query).not.toMatch(/WHERE 1 = 1 AND event_name = 'sale'/);
+ });
+});
diff --git a/server/src/api/analytics/sessions/getSessions.ts b/server/src/api/analytics/sessions/getSessions.ts
index b2aee217a..65eed11db 100644
--- a/server/src/api/analytics/sessions/getSessions.ts
+++ b/server/src/api/analytics/sessions/getSessions.ts
@@ -1,6 +1,14 @@
import { FilterParams } from "@rybbit/shared";
import { FastifyReply, FastifyRequest } from "fastify";
-import { SESSION_CHANNEL_AGG, SESSION_REFERRER_AGG } from "../utils/sessionAttribution.js";
+import {
+ SESSION_CHANNEL_AGG,
+ SESSION_REFERRER_AGG,
+ SESSION_UTM_CAMPAIGN_AGG,
+ SESSION_UTM_CONTENT_AGG,
+ SESSION_UTM_MEDIUM_AGG,
+ SESSION_UTM_SOURCE_AGG,
+ SESSION_UTM_TERM_AGG,
+} from "../utils/sessionAttribution.js";
import { getSessionFilterStatement } from "../utils/sessionFilters.js";
import { enrichWithTraits } from "../utils/utils.js";
import { getTimeStatement } from "../utils/timeWindow.js";
@@ -114,11 +122,11 @@ export const buildSessionsQuery = (query: GetSessionsRequest["Querystring"], sit
${SESSION_REFERRER_AGG} AS referrer,
${SESSION_CHANNEL_AGG} AS channel,
argMin(hostname, timestamp) AS hostname,
- argMin(url_parameters, timestamp)['utm_source'] AS utm_source,
- argMin(url_parameters, timestamp)['utm_medium'] AS utm_medium,
- argMin(url_parameters, timestamp)['utm_campaign'] AS utm_campaign,
- argMin(url_parameters, timestamp)['utm_term'] AS utm_term,
- argMin(url_parameters, timestamp)['utm_content'] AS utm_content,
+ ${SESSION_UTM_SOURCE_AGG} AS utm_source,
+ ${SESSION_UTM_MEDIUM_AGG} AS utm_medium,
+ ${SESSION_UTM_CAMPAIGN_AGG} AS utm_campaign,
+ ${SESSION_UTM_TERM_AGG} AS utm_term,
+ ${SESSION_UTM_CONTENT_AGG} AS utm_content,
MAX(timestamp) AS session_end,
MIN(timestamp) AS session_start,
dateDiff('second', MIN(timestamp), MAX(timestamp)) AS session_duration,
diff --git a/server/src/api/analytics/utils/sessionAttribution.test.ts b/server/src/api/analytics/utils/sessionAttribution.test.ts
new file mode 100644
index 000000000..811167860
--- /dev/null
+++ b/server/src/api/analytics/utils/sessionAttribution.test.ts
@@ -0,0 +1,16 @@
+import { describe, expect, it } from "vitest";
+import { goalSessionUtmAgg, SESSION_UTM_MEDIUM_AGG } from "./sessionAttribution.js";
+
+describe("session UTM attribution", () => {
+ it("uses the first non-empty utm value instead of the landing event map", () => {
+ expect(SESSION_UTM_MEDIUM_AGG).toBe(
+ "argMinIf(url_parameters['utm_medium'], timestamp, url_parameters['utm_medium'] != '')"
+ );
+ });
+
+ it("supports aliased goal session projections", () => {
+ expect(goalSessionUtmAgg("utm_medium")).toBe(
+ "argMinIf(e.url_parameters['utm_medium'], e.timestamp, e.url_parameters['utm_medium'] != '')"
+ );
+ });
+});
diff --git a/server/src/api/analytics/utils/sessionAttribution.ts b/server/src/api/analytics/utils/sessionAttribution.ts
index 79f918348..dd3491513 100644
--- a/server/src/api/analytics/utils/sessionAttribution.ts
+++ b/server/src/api/analytics/utils/sessionAttribution.ts
@@ -18,3 +18,28 @@ const UNATTRIBUTED_CHANNELS = "('Direct', 'Internal', '')";
// First attributed channel in the session, falling back to the first event's
// channel when no event in the session carries an acquisition signal.
export const SESSION_CHANNEL_AGG = `if(countIf(channel NOT IN ${UNATTRIBUTED_CHANNELS}) > 0, argMinIf(channel, timestamp, channel NOT IN ${UNATTRIBUTED_CHANNELS}), argMin(channel, timestamp))`;
+
+const sessionUtmAgg = (parameter: string, prefix?: string) => {
+ const urlParameters = prefix ? `${prefix}.url_parameters` : "url_parameters";
+ const timestamp = prefix ? `${prefix}.timestamp` : "timestamp";
+ return `argMinIf(${urlParameters}['${parameter}'], ${timestamp}, ${urlParameters}['${parameter}'] != '')`;
+};
+
+// First non-empty UTM value in the session. argMin(url_parameters, timestamp)['utm_*']
+// reads only the landing event's map; a heartbeat/custom event that lands first
+// would hide UTM tags that appear on the first pageview and break goal filters.
+export const SESSION_UTM_SOURCE_AGG = sessionUtmAgg("utm_source");
+export const SESSION_UTM_MEDIUM_AGG = sessionUtmAgg("utm_medium");
+export const SESSION_UTM_CAMPAIGN_AGG = sessionUtmAgg("utm_campaign");
+export const SESSION_UTM_TERM_AGG = sessionUtmAgg("utm_term");
+export const SESSION_UTM_CONTENT_AGG = sessionUtmAgg("utm_content");
+
+export const SESSION_UTM_AGG_BY_PARAMETER: Record<string, string> = {
+ utm_source: SESSION_UTM_SOURCE_AGG,
+ utm_medium: SESSION_UTM_MEDIUM_AGG,
+ utm_campaign: SESSION_UTM_CAMPAIGN_AGG,
+ utm_term: SESSION_UTM_TERM_AGG,
+ utm_content: SESSION_UTM_CONTENT_AGG,
+};
+
+export const goalSessionUtmAgg = (parameter: string) => sessionUtmAgg(parameter, "e");
diff --git a/server/src/api/analytics/utils/sessionFilters.test.ts b/server/src/api/analytics/utils/sessionFilters.test.ts
index 0e7368f9f..e1a007358 100644
--- a/server/src/api/analytics/utils/sessionFilters.test.ts
+++ b/server/src/api/analytics/utils/sessionFilters.test.ts
@@ -11,7 +11,7 @@ describe("buildFilteredSessionsCTE", () => {
it("projects only the aggregate needed by a UTM filter", () => {
const sql = build("utm_campaign", "launch");
- expect(sql).toContain("argMin(url_parameters, timestamp)['utm_campaign'] AS utm_campaign");
+ expect(sql).toContain("argMinIf(url_parameters['utm_campaign'], timestamp, url_parameters['utm_campaign'] != '') AS utm_campaign");
expect(sql).not.toContain("argMax(browser,");
expect(sql).not.toContain("AS utm_source");
expect(sql).not.toContain("feature_flags");
diff --git a/server/src/api/analytics/utils/sessionFilters.ts b/server/src/api/analytics/utils/sessionFilters.ts
index 8c991333a..764633985 100644
--- a/server/src/api/analytics/utils/sessionFilters.ts
+++ b/server/src/api/analytics/utils/sessionFilters.ts
@@ -1,7 +1,7 @@
import { FilterParameter } from "../types.js";
import { getFilterStatement } from "./getFilterStatement.js";
import { validateFilters } from "./query-validation.js";
-import { SESSION_REFERRER_AGG } from "./sessionAttribution.js";
+import { SESSION_REFERRER_AGG, SESSION_UTM_AGG_BY_PARAMETER } from "./sessionAttribution.js";
// These fields are event-scoped rather than stable session attributes. Session
// reports include a session when any event matches them; channel has its own
@@ -84,7 +84,9 @@ export const buildFilteredSessionsCTE = (
} else if (parameter === "referrer") {
aggregates.add(`${SESSION_REFERRER_AGG} AS referrer`);
} else if (parameter.startsWith("utm_")) {
- aggregates.add(`argMin(url_parameters, timestamp)['${parameter}'] AS ${parameter}`);
+ const utmAggregate = SESSION_UTM_AGG_BY_PARAMETER[parameter];
+ if (!utmAggregate) continue;
+ aggregates.add(`${utmAggregate} AS ${parameter}`);
} else if (parameter === "hostname") {
aggregates.add("argMin(hostname, timestamp) AS hostname");
} else if (parameter === "dimensions") {