Skip to content

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

Refactor API endpoints and data structures for site-based analytics

Bill Yangeb0ef0d03337
diff --git a/client/src/api/admin/sites.ts b/client/src/api/admin/sites.ts
index 35f10c14b..1868acb6a 100644
--- a/client/src/api/admin/sites.ts
+++ b/client/src/api/admin/sites.ts
@@ -10,6 +10,7 @@ export type GetSitesResponse = {
createdAt: string;
updatedAt: string;
createdBy: string;
+ public: boolean;
overMonthlyLimit?: boolean;
monthlyEventCount?: number;
eventLimit?: number;
diff --git a/client/src/api/analytics/useGetOverview.ts b/client/src/api/analytics/useGetOverview.ts
index 717407555..a0cf681c0 100644
--- a/client/src/api/analytics/useGetOverview.ts
+++ b/client/src/api/analytics/useGetOverview.ts
@@ -29,11 +29,10 @@ export function useGetOverview({
queryKey: ["overview", timeToUse, site, filters],
queryFn: () => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
- return authedFetch(`${BACKEND_URL}/overview`, {
+ return authedFetch(`${BACKEND_URL}/overview/${site}`, {
startDate,
endDate,
timezone,
- site,
filters,
}).then((res) => res.json());
},
@@ -62,10 +61,9 @@ export function useGetOverviewPastMinutes({
queryKey: ["overview-past-minutes", pastMinutes, site],
queryFn: () => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
- return authedFetch(`${BACKEND_URL}/overview`, {
+ return authedFetch(`${BACKEND_URL}/overview/${site}`, {
pastMinutes,
timezone,
- site,
}).then((res) => res.json());
},
staleTime: Infinity,
diff --git a/client/src/api/analytics/useGetOverviewBucketed.ts b/client/src/api/analytics/useGetOverviewBucketed.ts
index 393af888a..8cdf90624 100644
--- a/client/src/api/analytics/useGetOverviewBucketed.ts
+++ b/client/src/api/analytics/useGetOverviewBucketed.ts
@@ -33,12 +33,11 @@ export function useGetOverviewBucketed({
queryKey: ["overview-bucketed", timeToUse, bucket, site, filters],
queryFn: () => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
- return authedFetch(`${BACKEND_URL}/overview-bucketed`, {
+ return authedFetch(`${BACKEND_URL}/overview-bucketed/${site}`, {
startDate,
endDate,
timezone,
bucket,
- site,
filters,
}).then((res) => res.json());
},
@@ -71,10 +70,9 @@ export function useGetOverviewBucketedPastMinutes({
queryKey: ["overview-bucketed-past-minutes", pastMinutes, site, bucket],
queryFn: () => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
- return authedFetch(`${BACKEND_URL}/overview-bucketed`, {
+ return authedFetch(`${BACKEND_URL}/overview-bucketed/${site}`, {
timezone,
bucket,
- site,
pastMinutes,
}).then((res) => res.json());
},
diff --git a/client/src/api/analytics/useSingleCol.ts b/client/src/api/analytics/useSingleCol.ts
index 371463dfd..89e6faddc 100644
--- a/client/src/api/analytics/useSingleCol.ts
+++ b/client/src/api/analytics/useSingleCol.ts
@@ -33,11 +33,10 @@ export function useSingleCol({
queryKey: [parameter, timeToUse, site, filters, limit, useFilters],
queryFn: () => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
- return authedFetch(`${BACKEND_URL}/single-col`, {
+ return authedFetch(`${BACKEND_URL}/single-col/${site}`, {
startDate,
endDate,
timezone,
- site,
parameter,
limit,
filters: useFilters ? filters : undefined,
@@ -72,9 +71,8 @@ export function useSingleColRealtime({
queryKey: [parameter, site, limit, minutes],
queryFn: () => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
- return authedFetch(`${BACKEND_URL}/single-col`, {
+ return authedFetch(`${BACKEND_URL}/single-col/${site}`, {
timezone,
- site,
parameter,
limit,
minutes,
diff --git a/client/src/api/analytics/userInfo.ts b/client/src/api/analytics/userInfo.ts
index e91e5ec4e..bed61a960 100644
--- a/client/src/api/analytics/userInfo.ts
+++ b/client/src/api/analytics/userInfo.ts
@@ -27,7 +27,7 @@ export function useUserInfo(siteId: number, userId: string) {
queryFn: () => {
console.info("Fetching user info");
- return authedFetch(`${BACKEND_URL}/user/info/${siteId}/${userId}`)
+ return authedFetch(`${BACKEND_URL}/user/info/${userId}/${siteId}`)
.then((res) => res.json())
.then((res) => res.data);
},
diff --git a/client/src/api/analytics/userSessions.ts b/client/src/api/analytics/userSessions.ts
index f59baa793..08de288b8 100644
--- a/client/src/api/analytics/userSessions.ts
+++ b/client/src/api/analytics/userSessions.ts
@@ -34,11 +34,10 @@ export function useGetUserSessions(userId: string) {
queryKey: ["user-sessions", userId, time, site, filters],
queryFn: () => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
- return authedFetch(`${BACKEND_URL}/user/${userId}/sessions`, {
+ return authedFetch(`${BACKEND_URL}/user/${userId}/sessions/${site}`, {
startDate,
endDate,
timezone,
- site,
filters,
}).then((res) => res.json());
},
@@ -77,11 +76,10 @@ export function useGetSessionsInfinite(userId?: string) {
queryKey: ["sessions-infinite", time, site, filteredFilters, userId],
queryFn: ({ pageParam = 1 }) => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
- return authedFetch(`${BACKEND_URL}/sessions`, {
+ return authedFetch(`${BACKEND_URL}/sessions/${site}`, {
startDate: userId ? undefined : startDate,
endDate: userId ? undefined : endDate,
timezone,
- site,
filters: filteredFilters,
page: pageParam,
userId,
@@ -148,9 +146,9 @@ export function useGetSessionDetails(sessionId: string | null) {
queryFn: () => {
if (!sessionId) throw new Error("Session ID is required");
- return authedFetch(`${BACKEND_URL}/session/${sessionId}`, {
- site,
- }).then((res) => res.json());
+ return authedFetch(`${BACKEND_URL}/session/${sessionId}/${site}`).then(
+ (res) => res.json()
+ );
},
enabled: !!sessionId && !!site,
staleTime: Infinity,
diff --git a/client/src/api/analytics/users.ts b/client/src/api/analytics/users.ts
index 3309ff15e..4ee48de42 100644
--- a/client/src/api/analytics/users.ts
+++ b/client/src/api/analytics/users.ts
@@ -60,11 +60,10 @@ export function useGetUsers(options: GetUsersOptions) {
queryFn: async () => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
- return authedFetch(`${BACKEND_URL}/users`, {
+ return authedFetch(`${BACKEND_URL}/users/${site}`, {
startDate,
endDate,
timezone,
- site,
filters: filteredFilters,
page,
pageSize,
diff --git a/server/src/api/analytics/getLiveSessionLocations.ts b/server/src/api/analytics/getLiveSessionLocations.ts
index 274eeb0c8..bfcf58c8d 100644
--- a/server/src/api/analytics/getLiveSessionLocations.ts
+++ b/server/src/api/analytics/getLiveSessionLocations.ts
@@ -5,12 +5,12 @@ import { processResults } from "./utils.js";
export async function getLiveSessionLocations(
req: FastifyRequest<{
Params: {
- siteId: string;
+ site: string;
};
}>,
res: FastifyReply
) {
- const { siteId } = req.params;
+ const { site } = req.params;
const result = await clickhouse.query({
query: `
@@ -23,7 +23,7 @@ WITH stuff AS (
FROM
pageviews
WHERE
- site_id = {siteId:Int32}
+ site_id = {site:Int32}
AND timestamp > now() - interval '30 minute'
GROUP BY
session_id
@@ -40,7 +40,7 @@ GROUP BY
lon,
city`,
query_params: {
- siteId: Number(siteId),
+ site,
},
format: "JSONEachRow",
});
diff --git a/server/src/api/analytics/getOverview.ts b/server/src/api/analytics/getOverview.ts
index 91d9e22d8..f41b8f671 100644
--- a/server/src/api/analytics/getOverview.ts
+++ b/server/src/api/analytics/getOverview.ts
@@ -93,11 +93,13 @@ const getQuery = ({
};
export interface GenericRequest {
+ Params: {
+ site: string;
+ };
Querystring: {
startDate: string;
endDate: string;
timezone: string;
- site: string;
filters: string;
parameter: FilterParameter;
pastMinutes?: number;
@@ -109,8 +111,8 @@ export async function getOverview(
req: FastifyRequest<GenericRequest>,
res: FastifyReply
) {
- const { startDate, endDate, timezone, site, filters, pastMinutes } =
- req.query;
+ const { startDate, endDate, timezone, filters, pastMinutes } = req.query;
+ const site = req.params.site;
const userHasAccessToSite = await getUserHasAccessToSite(req, site);
if (!userHasAccessToSite) {
return res.status(403).send({ error: "Forbidden" });
diff --git a/server/src/api/analytics/getOverviewBucketed.ts b/server/src/api/analytics/getOverviewBucketed.ts
index 8862434a6..65a00c8fc 100644
--- a/server/src/api/analytics/getOverviewBucketed.ts
+++ b/server/src/api/analytics/getOverviewBucketed.ts
@@ -178,20 +178,23 @@ type getOverviewBucketed = { time: string; pageviews: number }[];
export async function getOverviewBucketed(
req: FastifyRequest<{
+ Params: {
+ site: string;
+ };
Querystring: {
startDate: string;
endDate: string;
timezone: string;
bucket: TimeBucket;
- site: string;
filters: string;
pastMinutes?: number;
};
}>,
res: FastifyReply
) {
- const { startDate, endDate, timezone, bucket, site, filters, pastMinutes } =
+ const { startDate, endDate, timezone, bucket, filters, pastMinutes } =
req.query;
+ const site = req.params.site;
const userHasAccessToSite = await getUserHasAccessToSite(req, site);
if (!userHasAccessToSite) {
diff --git a/server/src/api/analytics/getSession.ts b/server/src/api/analytics/getSession.ts
index dafb40c24..0aa48e26d 100644
--- a/server/src/api/analytics/getSession.ts
+++ b/server/src/api/analytics/getSession.ts
@@ -46,8 +46,6 @@ export interface SessionPageviewsAndEvents {
export interface GetSessionRequest {
Params: {
sessionId: string;
- };
- Querystring: {
site: string;
};
}
@@ -56,8 +54,7 @@ export async function getSession(
req: FastifyRequest<GetSessionRequest>,
res: FastifyReply
) {
- const { sessionId } = req.params;
- const { site } = req.query;
+ const { sessionId, site } = req.params;
const userHasAccessToSite = await getUserHasAccessToSite(req, site);
if (!userHasAccessToSite) {
diff --git a/server/src/api/analytics/getSessions.ts b/server/src/api/analytics/getSessions.ts
index e5da5b666..87f761489 100644
--- a/server/src/api/analytics/getSessions.ts
+++ b/server/src/api/analytics/getSessions.ts
@@ -29,11 +29,13 @@ export type GetSessionsResponse = {
}[];
export interface GetSessionsRequest {
+ Params: {
+ site: string;
+ };
Querystring: {
startDate: string;
endDate: string;
timezone: string;
- site: string;
filters: string;
page: number;
userId?: string;
@@ -44,8 +46,8 @@ export async function getSessions(
req: FastifyRequest<GetSessionsRequest>,
res: FastifyReply
) {
- const { startDate, endDate, timezone, site, filters, page, userId } =
- req.query;
+ const { startDate, endDate, timezone, filters, page, userId } = req.query;
+ const site = req.params.site;
const userHasAccessToSite = await getUserHasAccessToSite(req, site);
if (!userHasAccessToSite) {
return res.status(403).send({ error: "Forbidden" });
diff --git a/server/src/api/analytics/getSingleCol.ts b/server/src/api/analytics/getSingleCol.ts
index 9799acc74..5a87cf8e1 100644
--- a/server/src/api/analytics/getSingleCol.ts
+++ b/server/src/api/analytics/getSingleCol.ts
@@ -10,12 +10,14 @@ import { getUserHasAccessToSite } from "../../lib/auth-utils.js";
import { FilterParameter } from "./types.js";
interface GenericRequest {
+ Params: {
+ site: string;
+ };
Querystring: {
startDate: string;
endDate: string;
minutes: number;
timezone: string;
- site: string;
filters: string;
parameter: FilterParameter;
limit?: number;
@@ -30,17 +32,10 @@ type GetSingleColResponse = {
bounce_rate?: number;
}[];
-const getQuery = (request: GenericRequest["Querystring"]) => {
- const {
- startDate,
- endDate,
- timezone,
- site,
- filters,
- parameter,
- limit,
- minutes,
- } = request;
+const getQuery = (request: FastifyRequest<GenericRequest>) => {
+ const { startDate, endDate, timezone, filters, parameter, limit, minutes } =
+ request.query;
+ const site = request.params.site;
const filterStatement = getFilterStatement(filters);
@@ -154,14 +149,15 @@ export async function getSingleCol(
req: FastifyRequest<GenericRequest>,
res: FastifyReply
) {
- const { site, parameter } = req.query;
+ const { parameter } = req.query;
+ const site = req.params.site;
const userHasAccessToSite = await getUserHasAccessToSite(req, site);
if (!userHasAccessToSite) {
return res.status(403).send({ error: "Forbidden" });
}
- const query = getQuery(req.query);
+ const query = getQuery(req);
try {
const result = await clickhouse.query({
diff --git a/server/src/api/analytics/getUserInfo.ts b/server/src/api/analytics/getUserInfo.ts
index b8ad4f4ae..ee9efe91b 100644
--- a/server/src/api/analytics/getUserInfo.ts
+++ b/server/src/api/analytics/getUserInfo.ts
@@ -24,13 +24,13 @@ interface UserPageviewData {
export async function getUserInfo(
req: FastifyRequest<{
Params: {
- siteId: number;
+ site: string;
userId: string;
};
}>,
res: FastifyReply
) {
- const { userId, siteId } = req.params;
+ const { userId, site } = req.params;
try {
const queryResult = await clickhouse.query({
@@ -61,7 +61,7 @@ export async function getUserInfo(
pageviews
WHERE
user_id = {userId:String}
- AND site_id = {siteId:Int32}
+ AND site_id = {site:Int32}
GROUP BY
session_id,
user_id
@@ -90,7 +90,7 @@ export async function getUserInfo(
`,
query_params: {
userId,
- siteId: Number(siteId),
+ site,
},
format: "JSONEachRow",
});
diff --git a/server/src/api/analytics/getUsers.ts b/server/src/api/analytics/getUsers.ts
index b4f5ccde7..34ba7988c 100644
--- a/server/src/api/analytics/getUsers.ts
+++ b/server/src/api/analytics/getUsers.ts
@@ -24,11 +24,13 @@ export type GetUsersResponse = {
}[];
export interface GetUsersRequest {
+ Params: {
+ site: string;
+ };
Querystring: {
startDate: string;
endDate: string;
timezone: string;
- site: string;
filters: string;
page?: string;
pageSize?: string;
@@ -45,13 +47,13 @@ export async function getUsers(
startDate,
endDate,
timezone,
- site,
filters,
page = "1",
pageSize = "20",
sortBy = "last_seen",
sortOrder = "desc",
} = req.query;
+ const site = req.params.site;
const userHasAccessToSite = await getUserHasAccessToSite(req, site);
if (!userHasAccessToSite) {
diff --git a/server/src/db/postgres/schema.ts b/server/src/db/postgres/schema.ts
index 816b3a8e5..0e033f6ff 100644
--- a/server/src/db/postgres/schema.ts
+++ b/server/src/db/postgres/schema.ts
@@ -59,6 +59,7 @@ export const sites = pgTable(
.notNull()
.references(() => user.id),
organizationId: text("organization_id").references(() => organization.id),
+ public: boolean().default(false),
},
(table) => [
foreignKey({
diff --git a/server/src/index.ts b/server/src/index.ts
index d7da672a6..d59f88816 100644
--- a/server/src/index.ts
+++ b/server/src/index.ts
@@ -96,17 +96,13 @@ server.register(
{ auth: auth! }
);
+const PUBLIC_ROUTES = ["/health", "/track", "/script", "/auth", "/api/auth"];
+
server.addHook("onRequest", async (request, reply) => {
const { url } = request.raw;
// Bypass auth for health check and tracking
- if (
- url?.startsWith("/health") ||
- url?.startsWith("/track") ||
- url?.startsWith("/script") ||
- url?.startsWith("/auth") ||
- url?.startsWith("/api/auth")
- ) {
+ if (PUBLIC_ROUTES.includes(url ?? "")) {
return;
}
@@ -129,18 +125,19 @@ server.addHook("onRequest", async (request, reply) => {
}
});
+// Analytics
server.get("/live-user-count/:site", getLiveUsercount);
-server.get("/overview", getOverview);
-server.get("/overview-bucketed", getOverviewBucketed);
-server.get("/single-col", getSingleCol);
+server.get("/overview/:site", getOverview);
+server.get("/overview-bucketed/:site", getOverviewBucketed);
+server.get("/single-col/:site", getSingleCol);
server.get("/retention/:site", getRetention);
server.get("/site-has-data/:site", getSiteHasData);
-server.get("/sessions", getSessions);
-server.get("/session/:sessionId", getSession);
-server.get("/users", getUsers);
-server.get("/user/:userId/sessions", getUserSessions);
-server.get("/user/info/:siteId/:userId", getUserInfo);
-server.get("/live-session-locations/:siteId", getLiveSessionLocations);
+server.get("/sessions/:site", getSessions);
+server.get("/session/:sessionId/:site", getSession);
+server.get("/users/:site", getUsers);
+server.get("/user/:userId/sessions/:site", getUserSessions);
+server.get("/user/info/:userId/:site", getUserInfo);
+server.get("/live-session-locations/:site", getLiveSessionLocations);
server.post("/funnel/:site", getFunnel);
server.post("/funnel/create/:site", createFunnel);
server.get("/funnels/:site", getFunnels);