Skip to content

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

Enhance Filters and StandardSection components with new event name support

Bill Yanga50671fdbac3
diff --git a/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx b/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
index a13d11b8d..c6bc28672 100644
--- a/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
+++ b/client/src/app/[site]/components/SubHeader/Filters/Filters.tsx
@@ -43,6 +43,8 @@ function getParameterNameLabel(parameter: FilterParameter) {
return "Exit Page";
case "dimensions":
return "Dimension";
+ case "event_name":
+ return "Event Name";
default:
return parameter;
}
diff --git a/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx b/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx
index 9cc8bd77a..b97391ab0 100644
--- a/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx
+++ b/client/src/app/[site]/components/SubHeader/Filters/NewFilterButton.tsx
@@ -70,6 +70,10 @@ const FilterOptions: { label: string; value: FilterParameter }[] = [
label: "Screen Dimensions",
value: "dimensions",
},
+ {
+ label: "Event Name",
+ value: "event_name",
+ },
];
export function NewFilterButton() {
diff --git a/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx b/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx
index 35c52a29e..e30e53d01 100644
--- a/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx
+++ b/client/src/app/[site]/components/shared/StandardSection/StandardSection.tsx
@@ -99,6 +99,7 @@ export function StandardSection({
getLabel,
getValue,
getLink,
+ countLabel,
filterParameter,
}: {
title: string;
@@ -107,6 +108,7 @@ export function StandardSection({
getLabel: (item: SingleColResponse) => ReactNode;
getValue: (item: SingleColResponse) => string;
getLink?: (item: SingleColResponse) => string;
+ countLabel?: string;
filterParameter: FilterParameter;
}) {
const { data, isFetching, error, refetch } = useSingleCol({
@@ -165,7 +167,7 @@ export function StandardSection({
<>
<div className="flex flex-row gap-2 justify-between pr-1 text-xs text-neutral-400">
<div>{title}</div>
- <div>Sessions</div>
+ <div>{countLabel || "Sessions"}</div>
</div>
{data?.data?.slice(0, 10).map((e) => (
<Row
@@ -198,7 +200,7 @@ export function StandardSection({
<div className="flex flex-col gap-2">
<div className="flex flex-row gap-2 justify-between pr-20 text-sm text-neutral-400">
<div>{title}</div>
- <div>Sessions</div>
+ <div>{countLabel || "Sessions"}</div>
</div>
<div className="flex flex-col gap-2 max-h-[85vh] overflow-x-hidden">
{data?.data?.map((e) => (
diff --git a/client/src/app/[site]/main/components/sections/Countries.tsx b/client/src/app/[site]/main/components/sections/Countries.tsx
index 2e79fb966..b06b6abad 100644
--- a/client/src/app/[site]/main/components/sections/Countries.tsx
+++ b/client/src/app/[site]/main/components/sections/Countries.tsx
@@ -32,7 +32,6 @@ const getLanguageName = (languageCode: string) => {
// Just a language code
return languageNamesInEnglish.of(languageCode);
} catch (error) {
- console.error(error);
return languageCode;
}
};
diff --git a/client/src/app/[site]/main/components/sections/Events.tsx b/client/src/app/[site]/main/components/sections/Events.tsx
new file mode 100644
index 000000000..3edd40c4d
--- /dev/null
+++ b/client/src/app/[site]/main/components/sections/Events.tsx
@@ -0,0 +1,41 @@
+import { useState } from "react";
+import {
+ Tabs,
+ TabsContent,
+ TabsList,
+ TabsTrigger,
+} from "../../../../../components/ui/basic-tabs";
+import { Card, CardContent } from "../../../../../components/ui/card";
+import { StandardSection } from "../../../components/shared/StandardSection/StandardSection";
+
+type Tab = "events";
+
+export function Events() {
+ const [tab, setTab] = useState<Tab>("events");
+
+ return (
+ <Card>
+ <CardContent className="mt-2">
+ <Tabs
+ defaultValue="events"
+ value={tab}
+ onValueChange={(value) => setTab(value as Tab)}
+ >
+ <TabsList>
+ <TabsTrigger value="events">Custom Events</TabsTrigger>
+ </TabsList>
+ <TabsContent value="events">
+ <StandardSection
+ filterParameter="event_name"
+ title="Events"
+ countLabel="Count"
+ getValue={(e) => e.value}
+ getKey={(e) => e.value}
+ getLabel={(e) => e.value}
+ />
+ </TabsContent>
+ </Tabs>
+ </CardContent>
+ </Card>
+ );
+}
diff --git a/client/src/app/[site]/main/page.tsx b/client/src/app/[site]/main/page.tsx
index e1ab63656..7527c05b9 100644
--- a/client/src/app/[site]/main/page.tsx
+++ b/client/src/app/[site]/main/page.tsx
@@ -5,6 +5,7 @@ import { SubHeader } from "../components/SubHeader/SubHeader";
import { MainSection } from "./components/MainSection/MainSection";
import { Countries } from "./components/sections/Countries";
import { Devices } from "./components/sections/Devices";
+import { Events } from "./components/sections/Events";
import { Map } from "./components/sections/Map";
import { Pages } from "./components/sections/Pages";
import { Referrers } from "./components/sections/Referrers";
@@ -36,6 +37,7 @@ function MainPageContent({ site }: { site: string }) {
<Pages siteMetadata={siteMetadata} />
<Referrers />
<Countries />
+ <Events />
<Map />
{/* <Chloropleth /> */}
</div>
diff --git a/client/src/lib/store.ts b/client/src/lib/store.ts
index 5ac6817fd..13adeb54c 100644
--- a/client/src/lib/store.ts
+++ b/client/src/lib/store.ts
@@ -79,6 +79,7 @@ export type FilterParameter =
| "page_title"
| "querystring"
| "iso_3166_2"
+ | "event_name"
// derivative parameters
| "entry_page"
| "exit_page"
diff --git a/server/src/api/getOverview.ts b/server/src/api/getOverview.ts
index 009c522d3..694d550f2 100644
--- a/server/src/api/getOverview.ts
+++ b/server/src/api/getOverview.ts
@@ -34,8 +34,14 @@ const getQuery = ({
}) => {
const filterStatement = getFilterStatement(filters);
- if (past24Hours) {
- return `SELECT
+ // Define the time condition based on past24Hours flag
+ const timeCondition = past24Hours
+ ? `AND timestamp >= toTimeZone(now('${timezone}'), 'UTC') - INTERVAL 1 DAY
+ AND timestamp < toTimeZone(now('${timezone}'), 'UTC')`
+ : getTimeStatement(startDate, endDate, timezone);
+
+ // Single query template with parameterized time condition
+ return `SELECT
session_stats.sessions,
session_stats.pages_per_session,
session_stats.bounce_rate * 100 AS bounce_rate,
@@ -62,8 +68,7 @@ const getQuery = ({
WHERE
site_id = ${site}
${filterStatement}
- AND timestamp >= toTimeZone(now('${timezone}'), 'UTC') - INTERVAL 1 DAY
- AND timestamp < toTimeZone(now('${timezone}'), 'UTC')
+ ${timeCondition}
GROUP BY session_id
)
) AS session_stats
@@ -71,61 +76,13 @@ const getQuery = ({
(
-- Page-level and user-level metrics
SELECT
- COUNT(*) AS pageviews,
- COUNT(DISTINCT user_id) AS users
+ COUNT(CASE WHEN type = 'pageview' THEN 1 END) AS pageviews,
+ COUNT(DISTINCT CASE WHEN type = 'pageview' THEN user_id END) AS users
FROM pageviews
WHERE
site_id = ${site}
${filterStatement}
- AND timestamp >= toTimeZone(now('${timezone}'), 'UTC') - INTERVAL 1 DAY
- AND timestamp < toTimeZone(now('${timezone}'), 'UTC')
- AND type = 'pageview'
- ) AS page_stats`;
- }
-
- return `SELECT
- session_stats.sessions,
- session_stats.pages_per_session,
- session_stats.bounce_rate * 100 AS bounce_rate,
- session_stats.session_duration,
- page_stats.pageviews,
- page_stats.users
- FROM
- (
- -- Session-level metrics
- SELECT
- COUNT() AS sessions,
- AVG(pages_in_session) AS pages_per_session,
- sumIf(1, pages_in_session = 1) / COUNT() AS bounce_rate,
- AVG(end_time - start_time) AS session_duration
- FROM
- (
- -- One row per session
- SELECT
- session_id,
- MIN(timestamp) AS start_time,
- MAX(timestamp) AS end_time,
- COUNT(CASE WHEN type = 'pageview' THEN 1 END) AS pages_in_session
- FROM pageviews
- WHERE
- site_id = ${site}
- ${filterStatement}
- ${getTimeStatement(startDate, endDate, timezone)}
- GROUP BY session_id
- )
- ) AS session_stats
- CROSS JOIN
- (
- -- Page-level and user-level metrics
- SELECT
- COUNT(*) AS pageviews,
- COUNT(DISTINCT user_id) AS users
- FROM pageviews
- WHERE
- site_id = ${site}
- ${filterStatement}
- ${getTimeStatement(startDate, endDate, timezone)}
- AND type = 'pageview'
+ ${timeCondition}
) AS page_stats`;
};
diff --git a/server/src/api/getSingleCol.ts b/server/src/api/getSingleCol.ts
index fa68425de..a522ace54 100644
--- a/server/src/api/getSingleCol.ts
+++ b/server/src/api/getSingleCol.ts
@@ -40,33 +40,26 @@ const getQuery = (request: GenericRequest["Querystring"]) => {
2
) as percentage`;
- // if (["querystring", "page_title", "pathname"].includes(parameter)) {
- // }
-
- if (parameter === "exit_page") {
+ if (parameter === "event_name") {
return `
- SELECT
- pathname as value,
- COUNT(distinct(session_id)) as count,
- ${percentageStatement}
- FROM (
- SELECT
- session_id,
- argMax(hostname, timestamp) AS hostname,
- argMax(pathname, timestamp) AS pathname
- FROM pageviews
- WHERE
- site_id = ${site}
- ${filterStatement}
- ${getTimeStatement(startDate, endDate, timezone)}
- AND type = 'pageview'
- GROUP BY session_id
- ) AS exit_pages
- GROUP BY value ORDER BY count desc
- ${limit ? `LIMIT ${limit}` : ""};`;
+ SELECT
+ event_name as value,
+ COUNT(*) as count,
+ ${percentageStatement}
+ FROM pageviews
+ WHERE
+ site_id = ${site}
+ ${filterStatement}
+ ${getTimeStatement(startDate, endDate, timezone)}
+ AND type = 'custom_event'
+ GROUP BY event_name ORDER BY count desc
+ ${limit ? `LIMIT ${limit}` : ""};
+ `;
}
- if (parameter === "entry_page") {
+ if (parameter === "exit_page" || parameter === "entry_page") {
+ const arg = parameter === "exit_page" ? "argMax" : "argMin";
+
return `
SELECT
pathname as value,
@@ -75,16 +68,16 @@ const getQuery = (request: GenericRequest["Querystring"]) => {
FROM (
SELECT
session_id,
- argMin(hostname, timestamp) AS hostname,
- argMin(pathname, timestamp) AS pathname
+ ${arg}(hostname, timestamp) AS hostname,
+ ${arg}(pathname, timestamp) AS pathname
FROM pageviews
WHERE
site_id = ${site}
${filterStatement}
${getTimeStatement(startDate, endDate, timezone)}
- AND type = 'pageview'
+ // AND type = 'pageview'
GROUP BY session_id
- ) AS entry_pages
+ ) AS query
GROUP BY value ORDER BY count desc
${limit ? `LIMIT ${limit}` : ""};`;
}
@@ -99,7 +92,7 @@ const getQuery = (request: GenericRequest["Querystring"]) => {
site_id = ${site}
${filterStatement}
${getTimeStatement(startDate, endDate, timezone)}
- AND type = 'pageview'
+ // AND type = 'pageview'
GROUP BY value ORDER BY count desc
${limit ? `LIMIT ${limit}` : ""};
`;
@@ -147,7 +140,6 @@ export async function getSingleCol(
const data = await processResults<GetSingleColResponse[number]>(result);
return res.send({ data });
} catch (error) {
- console.log(query);
console.error(`Error fetching ${parameter}:`, error);
return res.status(500).send({ error: `Failed to fetch ${parameter}` });
}
diff --git a/server/src/api/types.ts b/server/src/api/types.ts
index 3eaf2950d..6741f4ff1 100644
--- a/server/src/api/types.ts
+++ b/server/src/api/types.ts
@@ -13,6 +13,7 @@ export type FilterParameter =
| "page_title"
| "querystring"
| "iso_3166_2"
+ | "event_name"
// derivative parameters
| "entry_page"
| "exit_page"