Skip to content

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

Add entry and exit page tracking to API and UI

Bill Yang1fa206195baa
diff --git a/client/src/app/[site]/main/components/sections/Pages.tsx b/client/src/app/[site]/main/components/sections/Pages.tsx
index a3a332053..51c9ae2de 100644
--- a/client/src/app/[site]/main/components/sections/Pages.tsx
+++ b/client/src/app/[site]/main/components/sections/Pages.tsx
@@ -16,7 +16,7 @@ import {
import { StandardSection } from "../../../components/shared/StandardSection";
import { GetSitesResponse } from "../../../../../api/admin/sites";
-type Tab = "pages";
+type Tab = "pages" | "entry_pages" | "exit_pages";
export function Pages({
siteMetadata,
@@ -37,11 +37,33 @@ export function Pages({
>
<TabsList>
<TabsTrigger value="pages">Pages</TabsTrigger>
+ <TabsTrigger value="entry_pages">Entry Pages</TabsTrigger>
+ <TabsTrigger value="exit_pages">Exit Pages</TabsTrigger>
</TabsList>
<TabsContent value="pages">
<StandardSection
filterParameter="pathname"
- title="pages"
+ title="Pages"
+ getValue={(e) => e.value}
+ getKey={(e) => e.value}
+ getLabel={(e) => e.value || "Other"}
+ getLink={(e) => `https://${siteMetadata.domain}${e.value}`}
+ />
+ </TabsContent>
+ <TabsContent value="entry_pages">
+ <StandardSection
+ filterParameter="entry_page"
+ title="Entry Pages"
+ getValue={(e) => e.value}
+ getKey={(e) => e.value}
+ getLabel={(e) => e.value || "Other"}
+ getLink={(e) => `https://${siteMetadata.domain}${e.value}`}
+ />
+ </TabsContent>
+ <TabsContent value="exit_pages">
+ <StandardSection
+ filterParameter="exit_page"
+ title="Exit Pages"
getValue={(e) => e.value}
getKey={(e) => e.value}
getLabel={(e) => e.value || "Other"}
diff --git a/client/src/lib/store.ts b/client/src/lib/store.ts
index e0511134e..2ba83a127 100644
--- a/client/src/lib/store.ts
+++ b/client/src/lib/store.ts
@@ -78,7 +78,9 @@ export type FilterParameter =
| "pathname"
| "page_title"
| "querystring"
- | "iso_3166_2";
+ | "iso_3166_2"
+ | "entry_page"
+ | "exit_page";
export type Filter = {
parameter: FilterParameter;
diff --git a/server/src/api/getSingleCol.ts b/server/src/api/getSingleCol.ts
index 54accab4f..714174ee4 100644
--- a/server/src/api/getSingleCol.ts
+++ b/server/src/api/getSingleCol.ts
@@ -15,21 +15,55 @@ type GetSingleColResponse = {
percentage: number;
}[];
-export async function getSingleCol(
- req: FastifyRequest<GenericRequest>,
- res: FastifyReply
-) {
+const getQuery = (request: GenericRequest["Querystring"]) => {
const { startDate, endDate, timezone, site, filters, parameter, limit } =
- req.query;
+ request;
- const userHasAccessToSite = await getUserHasAccessToSite(req, site);
- if (!userHasAccessToSite) {
- return res.status(403).send({ error: "Forbidden" });
+ const filterStatement = getFilterStatement(filters);
+
+ if (parameter === "exit_page") {
+ return `
+ SELECT
+ pathname as value,
+ COUNT(*) as count,
+ ROUND(COUNT(*) * 100.0 / SUM(COUNT(*)) OVER (), 2) as percentage
+ FROM (
+ SELECT
+ session_id,
+ argMax(hostname, timestamp) AS hostname,
+ argMax(pathname, timestamp) AS pathname
+ FROM pageviews
+ WHERE
+ site_id = ${site}
+ ${getTimeStatement(startDate, endDate, timezone)}
+ GROUP BY session_id
+ ) AS exit_pages
+ GROUP BY value ORDER BY count desc
+ ${limit ? `LIMIT ${limit}` : ""};`;
}
- const filterStatement = getFilterStatement(filters);
+ if (parameter === "entry_page") {
+ return `
+ SELECT
+ pathname as value,
+ COUNT(*) as count,
+ ROUND(COUNT(*) * 100.0 / SUM(COUNT(*)) OVER (), 2) as percentage
+ FROM (
+ SELECT
+ session_id,
+ argMin(hostname, timestamp) AS hostname,
+ argMin(pathname, timestamp) AS pathname
+ FROM pageviews
+ WHERE
+ site_id = ${site}
+ ${getTimeStatement(startDate, endDate, timezone)}
+ GROUP BY session_id
+ ) AS entry_pages
+ GROUP BY value ORDER BY count desc
+ ${limit ? `LIMIT ${limit}` : ""};`;
+ }
- const query = `
+ return `
SELECT
${geSqlParam(parameter)} as value,
COUNT(*) as count,
@@ -41,8 +75,22 @@ export async function getSingleCol(
${getTimeStatement(startDate, endDate, timezone)}
AND type = 'pageview'
GROUP BY value ORDER BY count desc
- ${limit ? `LIMIT ${limit}` : ""};
+ ${limit ? `LIMIT ${limit}` : ""};
`;
+};
+
+export async function getSingleCol(
+ req: FastifyRequest<GenericRequest>,
+ res: FastifyReply
+) {
+ const { site, parameter } = req.query;
+
+ const userHasAccessToSite = await getUserHasAccessToSite(req, site);
+ if (!userHasAccessToSite) {
+ return res.status(403).send({ error: "Forbidden" });
+ }
+
+ const query = getQuery(req.query);
try {
const result = await clickhouse.query({
diff --git a/server/src/api/types.ts b/server/src/api/types.ts
index 0f34daecc..493f38b68 100644
--- a/server/src/api/types.ts
+++ b/server/src/api/types.ts
@@ -11,7 +11,10 @@ export type FilterParameter =
| "referrer"
| "pathname"
| "page_title"
- | "querystring";
+ | "querystring"
+ | "iso_3166_2"
+ | "entry_page"
+ | "exit_page";
export type Filter = {
parameter: FilterParameter;
diff --git a/server/src/tracker/trackEvent.ts b/server/src/tracker/trackEvent.ts
index d0a78e99d..82e6a1063 100644
--- a/server/src/tracker/trackEvent.ts
+++ b/server/src/tracker/trackEvent.ts
@@ -1,10 +1,8 @@
import { FastifyReply, FastifyRequest } from "fastify";
-import { TrackingPayload } from "../types.js";
import {
BaseTrackingPayload,
createBasePayload,
getExistingSession,
- isSiteOverLimit,
processTrackingEvent,
} from "./trackingUtils.js";