Skip to content

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

Refactor analytics filters and improve structure

Bill Yang86feb293c0cd
diff --git a/client/src/api/analytics/events/useGetEventNames.ts b/client/src/api/analytics/events/useGetEventNames.ts
index 56df0f16e..7d6c9edec 100644
--- a/client/src/api/analytics/events/useGetEventNames.ts
+++ b/client/src/api/analytics/events/useGetEventNames.ts
@@ -1,5 +1,6 @@
import { useQuery } from "@tanstack/react-query";
-import { useStore, getFilteredFilters, EVENT_FILTERS } from "../../../lib/store";
+import { getFilteredFilters, useStore } from "../../../lib/store";
+import { EVENT_FILTERS } from "../../../lib/filterGroups";
import { authedFetch, getQueryParams } from "../../utils";
export type EventName = {
diff --git a/client/src/api/analytics/events/useGetEventProperties.ts b/client/src/api/analytics/events/useGetEventProperties.ts
index 7de042efa..73b046e02 100644
--- a/client/src/api/analytics/events/useGetEventProperties.ts
+++ b/client/src/api/analytics/events/useGetEventProperties.ts
@@ -1,5 +1,6 @@
import { useQuery } from "@tanstack/react-query";
-import { useStore, getFilteredFilters, EVENT_FILTERS } from "../../../lib/store";
+import { getFilteredFilters, useStore } from "../../../lib/store";
+import { EVENT_FILTERS } from "../../../lib/filterGroups";
import { authedFetch, getQueryParams } from "../../utils";
export type EventProperty = {
diff --git a/client/src/api/analytics/events/useGetOutboundLinks.ts b/client/src/api/analytics/events/useGetOutboundLinks.ts
index ee336ceb8..4fbfcef5c 100644
--- a/client/src/api/analytics/events/useGetOutboundLinks.ts
+++ b/client/src/api/analytics/events/useGetOutboundLinks.ts
@@ -1,5 +1,6 @@
import { useQuery } from "@tanstack/react-query";
-import { useStore, getFilteredFilters, EVENT_FILTERS } from "../../../lib/store";
+import { getFilteredFilters, useStore } from "../../../lib/store";
+import { EVENT_FILTERS } from "../../../lib/filterGroups";
import { authedFetch, getQueryParams } from "../../utils";
export type OutboundLink = {
diff --git a/client/src/api/analytics/goals/useGetGoals.ts b/client/src/api/analytics/goals/useGetGoals.ts
index 0864cafba..f114d78e4 100644
--- a/client/src/api/analytics/goals/useGetGoals.ts
+++ b/client/src/api/analytics/goals/useGetGoals.ts
@@ -1,5 +1,6 @@
import { useQuery } from "@tanstack/react-query";
-import { getFilteredFilters, GOALS_PAGE_FILTERS, useStore } from "../../../lib/store";
+import { getFilteredFilters, useStore } from "../../../lib/store";
+import { GOALS_PAGE_FILTERS } from "../../../lib/filterGroups";
import { authedFetch, getQueryParams } from "../../utils";
export interface Goal {
diff --git a/client/src/api/analytics/useJourneys.ts b/client/src/api/analytics/useJourneys.ts
index d81b0ab94..6f2717982 100644
--- a/client/src/api/analytics/useJourneys.ts
+++ b/client/src/api/analytics/useJourneys.ts
@@ -1,7 +1,8 @@
import { useQuery } from "@tanstack/react-query";
import { Time } from "../../components/DateSelector/types";
import { timeZone } from "../../lib/dateTimeUtils";
-import { getFilteredFilters, JOURNEY_PAGE_FILTERS } from "../../lib/store";
+import { getFilteredFilters } from "../../lib/store";
+import { JOURNEY_PAGE_FILTERS } from "../../lib/filterGroups";
import { authedFetch, getStartAndEndDate } from "../utils";
export interface JourneyParams {
diff --git a/client/src/api/analytics/userSessions.ts b/client/src/api/analytics/userSessions.ts
index 0ba838e16..3413e9e81 100644
--- a/client/src/api/analytics/userSessions.ts
+++ b/client/src/api/analytics/userSessions.ts
@@ -1,6 +1,7 @@
import { useInfiniteQuery, useQuery } from "@tanstack/react-query";
import { timeZone } from "../../lib/dateTimeUtils";
-import { getFilteredFilters, SESSION_PAGE_FILTERS, useStore } from "../../lib/store";
+import { getFilteredFilters, useStore } from "../../lib/store";
+import { SESSION_PAGE_FILTERS } from "../../lib/filterGroups";
import { APIResponse } from "../types";
import { authedFetch, getQueryParams } from "../utils";
@@ -20,6 +21,9 @@ export type GetSessionsResponse = {
screen_height: number;
referrer: string;
channel: string;
+ hostname: string;
+ page_title: string;
+ querystring: string;
utm_source: string;
utm_medium: string;
utm_campaign: string;
diff --git a/client/src/api/analytics/users.ts b/client/src/api/analytics/users.ts
index 6e4175a59..3423f339a 100644
--- a/client/src/api/analytics/users.ts
+++ b/client/src/api/analytics/users.ts
@@ -1,7 +1,8 @@
import { Filter } from "@rybbit/shared";
import { useQuery } from "@tanstack/react-query";
import { timeZone } from "../../lib/dateTimeUtils";
-import { USER_PAGE_FILTERS, getFilteredFilters, useStore } from "../../lib/store";
+import { getFilteredFilters, useStore } from "../../lib/store";
+import { USER_PAGE_FILTERS } from "../../lib/filterGroups";
import { APIResponse } from "../types";
import { authedFetch, getQueryParams } from "../utils";
diff --git a/client/src/app/[site]/components/shared/Filters/utils.ts b/client/src/app/[site]/components/shared/Filters/utils.ts
index da43a1767..506ccd453 100644
--- a/client/src/app/[site]/components/shared/Filters/utils.ts
+++ b/client/src/app/[site]/components/shared/Filters/utils.ts
@@ -55,6 +55,8 @@ export function getParameterNameLabel(parameter: FilterParameter) {
return "Lat";
case "lon":
return "Lon";
+ case "hostname":
+ return "Hostname";
default:
return parameter;
}
diff --git a/client/src/app/[site]/events/page.tsx b/client/src/app/[site]/events/page.tsx
index d71d90608..5b39feef7 100644
--- a/client/src/app/[site]/events/page.tsx
+++ b/client/src/app/[site]/events/page.tsx
@@ -1,7 +1,7 @@
"use client";
import { Card, CardContent, CardHeader, CardTitle } from "@/components/ui/card";
-import { EVENT_FILTERS } from "@/lib/store";
+import { EVENT_FILTERS } from "@/lib/filterGroups";
import { useGetEventNames } from "../../../api/analytics/events/useGetEventNames";
import { DisabledOverlay } from "../../../components/DisabledOverlay";
import { useSetPageTitle } from "../../../hooks/useSetPageTitle";
diff --git a/client/src/app/[site]/funnels/page.tsx b/client/src/app/[site]/funnels/page.tsx
index e057287b4..e80d8579f 100644
--- a/client/src/app/[site]/funnels/page.tsx
+++ b/client/src/app/[site]/funnels/page.tsx
@@ -2,7 +2,8 @@
import { SavedFunnel, useGetFunnels } from "../../../api/analytics/funnels/useGetFunnels";
import { Skeleton } from "@/components/ui/skeleton";
-import { GOALS_PAGE_FILTERS, useStore } from "@/lib/store";
+import { useStore } from "@/lib/store";
+import { GOALS_PAGE_FILTERS } from "@/lib/filterGroups";
import { ArrowRight, FilterIcon, Funnel } from "lucide-react";
import { NothingFound } from "../../../components/NothingFound";
import { CreateFunnelDialog } from "./components/CreateFunnel";
diff --git a/client/src/app/[site]/globe/3d/hooks/timelineLayer/useTimelineSessions.ts b/client/src/app/[site]/globe/3d/hooks/timelineLayer/useTimelineSessions.ts
index 1108db3b1..bd5e474d3 100644
--- a/client/src/app/[site]/globe/3d/hooks/timelineLayer/useTimelineSessions.ts
+++ b/client/src/app/[site]/globe/3d/hooks/timelineLayer/useTimelineSessions.ts
@@ -4,7 +4,8 @@ import { useEffect, useMemo } from "react";
import { GetSessionsResponse } from "../../../../../../api/analytics/userSessions";
import { APIResponse } from "../../../../../../api/types";
import { authedFetch, getQueryParams } from "../../../../../../api/utils";
-import { getFilteredFilters, SESSION_PAGE_FILTERS, useStore } from "../../../../../../lib/store";
+import { getFilteredFilters, useStore } from "../../../../../../lib/store";
+import { SESSION_PAGE_FILTERS } from "../../../../../../lib/filterGroups";
import { useTimelineStore } from "../../../timelineStore";
import { calculateWindowSize } from "../../../timelineUtils";
import { MAX_PAGES, PAGE_SIZE } from "./timelineLayerConstants";
diff --git a/client/src/app/[site]/goals/page.tsx b/client/src/app/[site]/goals/page.tsx
index e8ca6f7d4..ab4f4eb45 100644
--- a/client/src/app/[site]/goals/page.tsx
+++ b/client/src/app/[site]/goals/page.tsx
@@ -6,7 +6,8 @@ import { DisabledOverlay } from "../../../components/DisabledOverlay";
import { NothingFound } from "../../../components/NothingFound";
import { Pagination } from "../../../components/pagination";
import { useSetPageTitle } from "../../../hooks/useSetPageTitle";
-import { GOALS_PAGE_FILTERS, useStore } from "../../../lib/store";
+import { useStore } from "../../../lib/store";
+import { GOALS_PAGE_FILTERS } from "../../../lib/filterGroups";
import { SubHeader } from "../components/SubHeader/SubHeader";
import CreateGoalButton from "./components/CreateGoalButton";
import GoalsList from "./components/GoalsList";
diff --git a/client/src/app/[site]/journeys/page.tsx b/client/src/app/[site]/journeys/page.tsx
index 87d469a2c..f5aabb1a1 100644
--- a/client/src/app/[site]/journeys/page.tsx
+++ b/client/src/app/[site]/journeys/page.tsx
@@ -10,7 +10,8 @@ import { useGetSite } from "../../../api/admin/sites";
import { DisabledOverlay } from "../../../components/DisabledOverlay";
import { useSetPageTitle } from "../../../hooks/useSetPageTitle";
import { timeZone } from "../../../lib/dateTimeUtils";
-import { JOURNEY_PAGE_FILTERS, useStore } from "../../../lib/store";
+import { useStore } from "../../../lib/store";
+import { JOURNEY_PAGE_FILTERS } from "../../../lib/filterGroups";
import { SubHeader } from "../components/SubHeader/SubHeader";
import { SankeyDiagram } from "./components/SankeyDiagram";
diff --git a/client/src/app/[site]/replay/page.tsx b/client/src/app/[site]/replay/page.tsx
index 9da9b626b..4d44ae7ce 100644
--- a/client/src/app/[site]/replay/page.tsx
+++ b/client/src/app/[site]/replay/page.tsx
@@ -4,7 +4,7 @@ import { useMeasure } from "@uidotdev/usehooks";
import { useGetSessionReplays } from "../../../api/analytics/sessionReplay/useGetSessionReplays";
import { DisabledOverlay } from "../../../components/DisabledOverlay";
import { useSetPageTitle } from "../../../hooks/useSetPageTitle";
-import { SESSION_REPLAY_PAGE_FILTERS } from "../../../lib/store";
+import { SESSION_REPLAY_PAGE_FILTERS } from "../../../lib/filterGroups";
import { SubHeader } from "../components/SubHeader/SubHeader";
import { EnableSessionReplay } from "./components/EnableSessionReplay";
import { ReplayList } from "./components/ReplayList";
diff --git a/client/src/app/[site]/sessions/page.tsx b/client/src/app/[site]/sessions/page.tsx
index 73880116b..8a745e49f 100644
--- a/client/src/app/[site]/sessions/page.tsx
+++ b/client/src/app/[site]/sessions/page.tsx
@@ -2,7 +2,7 @@
import { DisabledOverlay } from "../../../components/DisabledOverlay";
import { useSetPageTitle } from "../../../hooks/useSetPageTitle";
-import { SESSION_PAGE_FILTERS } from "../../../lib/store";
+import { SESSION_PAGE_FILTERS } from "../../../lib/filterGroups";
import { SubHeader } from "../components/SubHeader/SubHeader";
import SessionsList from "@/components/Sessions/SessionsList";
diff --git a/client/src/app/[site]/users/page.tsx b/client/src/app/[site]/users/page.tsx
index d9f41928e..5aea1f2ec 100644
--- a/client/src/app/[site]/users/page.tsx
+++ b/client/src/app/[site]/users/page.tsx
@@ -23,7 +23,7 @@ import { Pagination } from "../../../components/pagination";
import { Button } from "../../../components/ui/button";
import { Tooltip, TooltipContent, TooltipTrigger } from "../../../components/ui/tooltip";
import { useSetPageTitle } from "../../../hooks/useSetPageTitle";
-import { USER_PAGE_FILTERS } from "../../../lib/store";
+import { USER_PAGE_FILTERS } from "../../../lib/filterGroups";
import { getCountryName } from "../../../lib/utils";
import { Browser } from "../components/shared/icons/Browser";
import { CountryFlag } from "../components/shared/icons/CountryFlag";
diff --git a/client/src/lib/filterGroups.ts b/client/src/lib/filterGroups.ts
new file mode 100644
index 000000000..6aea22058
--- /dev/null
+++ b/client/src/lib/filterGroups.ts
@@ -0,0 +1,99 @@
+import { FilterParameter } from "@rybbit/shared";
+
+const BASE_FILTERS: FilterParameter[] = [
+ "hostname",
+ "browser",
+ "browser_version",
+ "operating_system",
+ "operating_system_version",
+ "language",
+ "country",
+ "region",
+ "city",
+ "device_type",
+ "referrer",
+ "page_title",
+ "querystring",
+ "channel",
+ "utm_source",
+ "utm_medium",
+ "utm_campaign",
+ "utm_term",
+ "utm_content",
+ "dimensions",
+ "user_id",
+ "lat",
+ "lon",
+];
+
+export const SESSION_PAGE_FILTERS: FilterParameter[] = [...BASE_FILTERS, "entry_page", "exit_page"];
+
+export const EVENT_FILTERS: FilterParameter[] = [
+ ...BASE_FILTERS,
+ "pathname",
+ "page_title",
+ "event_name",
+ "entry_page",
+ "exit_page",
+];
+
+export const GOALS_PAGE_FILTERS: FilterParameter[] = [...BASE_FILTERS, "event_name"];
+
+export const USER_PAGE_FILTERS: FilterParameter[] = [
+ "hostname",
+ "browser",
+ "browser_version",
+ "operating_system",
+ "operating_system_version",
+ "language",
+ "country",
+ "region",
+ "city",
+ "device_type",
+ "referrer",
+ "user_id",
+ "lat",
+ "lon",
+];
+
+export const JOURNEY_PAGE_FILTERS: FilterParameter[] = [
+ "browser",
+ "operating_system",
+ "language",
+ "country",
+ "region",
+ "city",
+ "device_type",
+ "referrer",
+ "hostname",
+ // "channel",
+ // "utm_source",
+ // "utm_medium",
+ // "utm_campaign",
+ // "utm_term",
+ // "utm_content",
+ "entry_page",
+ "exit_page",
+ "dimensions",
+ "browser_version",
+ "operating_system_version",
+ "user_id",
+ "lat",
+ "lon",
+];
+
+export const SESSION_REPLAY_PAGE_FILTERS: FilterParameter[] = [
+ "hostname",
+ "browser",
+ "browser_version",
+ "operating_system",
+ "operating_system_version",
+ "language",
+ "country",
+ "region",
+ "city",
+ "device_type",
+ "referrer",
+ "channel",
+ "user_id",
+];
diff --git a/client/src/lib/store.ts b/client/src/lib/store.ts
index a453938b0..b0e7e924b 100644
--- a/client/src/lib/store.ts
+++ b/client/src/lib/store.ts
@@ -5,139 +5,6 @@ import { Time } from "../components/DateSelector/types";
export type StatType = "pageviews" | "sessions" | "users" | "pages_per_session" | "bounce_rate" | "session_duration";
-export const SESSION_PAGE_FILTERS: FilterParameter[] = [
- "hostname",
- "browser",
- "browser_version",
- "operating_system",
- "operating_system_version",
- "language",
- "country",
- "region",
- "city",
- "device_type",
- "referrer",
- "event_name",
- "channel",
- "entry_page",
- "exit_page",
- "utm_source",
- "utm_medium",
- "utm_campaign",
- "utm_term",
- "utm_content",
- "user_id",
- "lat",
- "lon",
-];
-
-export const SESSION_REPLAY_PAGE_FILTERS: FilterParameter[] = [
- "hostname",
- "browser",
- "browser_version",
- "operating_system",
- "operating_system_version",
- "language",
- "country",
- "region",
- "city",
- "device_type",
- "referrer",
- "channel",
- "user_id",
-];
-
-export const EVENT_FILTERS: FilterParameter[] = [
- // "event_name",
- // "browser",
- // "operating_system",
- // "country",
- // "device_type",
- // "referrer",
- "hostname",
- "browser",
- "browser_version",
- "operating_system",
- "operating_system_version",
- "language",
- "country",
- "region",
- "city",
- "device_type",
- "referrer",
- "pathname",
- "page_title",
- "querystring",
- "event_name",
- "channel",
- "utm_source",
- "utm_medium",
- "utm_campaign",
- "utm_term",
- "utm_content",
- "entry_page",
- "exit_page",
- "dimensions",
- "user_id",
-];
-
-export const GOALS_PAGE_FILTERS: FilterParameter[] = [
- "hostname",
- "browser",
- "browser_version",
- "operating_system",
- "operating_system_version",
- "language",
- "country",
- "region",
- "city",
- "device_type",
- "referrer",
- "event_name",
- "channel",
- "entry_page",
- "exit_page",
-];
-
-export const USER_PAGE_FILTERS: FilterParameter[] = [
- "hostname",
- "browser",
- "browser_version",
- "operating_system",
- "operating_system_version",
- "language",
- "country",
- "region",
- "city",
- "device_type",
- "referrer",
- "user_id",
-];
-
-export const JOURNEY_PAGE_FILTERS: FilterParameter[] = [
- "browser",
- "operating_system",
- "language",
- "country",
- "region",
- "city",
- "device_type",
- "referrer",
- "hostname",
- // "channel",
- // "utm_source",
- // "utm_medium",
- // "utm_campaign",
- // "utm_term",
- // "utm_content",
- "entry_page",
- "exit_page",
- "dimensions",
- "browser_version",
- "operating_system_version",
- "user_id",
-];
-
type Store = {
site: string;
setSite: (site: string) => void;
diff --git a/server/src/api/analytics/getSessions.ts b/server/src/api/analytics/getSessions.ts
index 65078da72..935dca19e 100644
--- a/server/src/api/analytics/getSessions.ts
+++ b/server/src/api/analytics/getSessions.ts
@@ -20,6 +20,9 @@ export type GetSessionsResponse = {
screen_height: number;
referrer: string;
channel: string;
+ hostname: string;
+ page_title: string;
+ querystring: string;
utm_source: string;
utm_medium: string;
utm_campaign: string;
@@ -79,6 +82,7 @@ export async function getSessions(req: FastifyRequest<GetSessionsRequest>, res:
argMax(screen_height, timestamp) AS screen_height,
argMin(referrer, timestamp) AS referrer,
argMin(channel, timestamp) AS channel,
+ argMin(hostname, timestamp) AS hostname,
/* UTM parameters from url_parameters map */
argMin(url_parameters, timestamp)['utm_source'] AS utm_source,
argMin(url_parameters, timestamp)['utm_medium'] AS utm_medium,
diff --git a/server/src/api/analytics/getUsers.ts b/server/src/api/analytics/getUsers.ts
index a03655b7c..e86e837f2 100644
--- a/server/src/api/analytics/getUsers.ts
+++ b/server/src/api/analytics/getUsers.ts
@@ -16,6 +16,7 @@ export type GetUsersResponse = {
pageviews: number;
events: number;
sessions: number;
+ hostname: string;
last_seen: string;
first_seen: string;
}[];
@@ -80,6 +81,7 @@ WITH AggregatedUsers AS (
argMax(screen_height, timestamp) AS screen_height,
argMin(referrer, timestamp) AS referrer,
argMax(channel, timestamp) AS channel,
+ argMin(hostname, timestamp) AS hostname,
countIf(type = 'pageview') AS pageviews,
countIf(type = 'custom_event') AS events,
count(distinct session_id) AS sessions,