Skip to content

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

Remove deprecated performance analytics hooks and implement past 24-hour mode support in existing hooks. Updated `useGetPerformanceOverview` and `useGetPerformanceTimeSeries` to handle last-24-hours queries with conditional parameters, ensuring consistent API behavior across analytics functions.

Bill Yang890edcb1b1d7
diff --git a/client/src/api/analytics/useGetPerformanceByPath.ts b/client/src/api/analytics/useGetPerformanceByPath.ts
deleted file mode 100644
index 707698b40..000000000
--- a/client/src/api/analytics/useGetPerformanceByPath.ts
+++ /dev/null
@@ -1,142 +0,0 @@
-import { Filter } from "@rybbit/shared";
-import { useQuery, UseQueryResult } from "@tanstack/react-query";
-import { usePerformanceStore } from "../../app/[site]/performance/performanceStore";
-import { timeZone } from "../../lib/dateTimeUtils";
-import { useStore } from "../../lib/store";
-import { authedFetch, getStartAndEndDate } from "../utils";
-
-type UseGetPerformanceByPathOptions = {
- site: number | string;
- limit?: number;
- page?: number;
- useFilters?: boolean;
- enabled?: boolean;
- additionalFilters?: Filter[];
- sortBy?: string;
- sortOrder?: "asc" | "desc";
-};
-
-// Import the correct type from backend
-export type PerformanceByPathItem = {
- pathname: string;
- event_count: number;
- lcp_avg: number | null;
- lcp_p50: number | null;
- lcp_p75: number | null;
- lcp_p90: number | null;
- lcp_p99: number | null;
- cls_avg: number | null;
- cls_p50: number | null;
- cls_p75: number | null;
- cls_p90: number | null;
- cls_p99: number | null;
- inp_avg: number | null;
- inp_p50: number | null;
- inp_p75: number | null;
- inp_p90: number | null;
- inp_p99: number | null;
- fcp_avg: number | null;
- fcp_p50: number | null;
- fcp_p75: number | null;
- fcp_p90: number | null;
- fcp_p99: number | null;
- ttfb_avg: number | null;
- ttfb_p50: number | null;
- ttfb_p75: number | null;
- ttfb_p90: number | null;
- ttfb_p99: number | null;
-};
-
-type PaginatedPerformanceResponse = {
- data: PerformanceByPathItem[];
- totalCount: number;
-};
-
-// Keep the old type for backward compatibility, but mark as deprecated
-/** @deprecated Use PerformanceByPathItem instead */
-export type PerformanceByPathResponse = {
- path: string;
- lcp: number;
- cls: number;
- inp: number;
- fcp: number;
- ttfb: number;
- pageviews: number;
-};
-
-export function useGetPerformanceByPath({
- site,
- limit = 10,
- page = 1,
- useFilters = true,
- enabled = true,
- additionalFilters = [],
- sortBy,
- sortOrder,
-}: UseGetPerformanceByPathOptions): UseQueryResult<PaginatedPerformanceResponse> {
- const { time, filters } = useStore();
- const { selectedPercentile } = usePerformanceStore();
-
- // Check if we're using last-24-hours mode
- const isPast24HoursMode = time.mode === "last-24-hours";
-
- // Determine the query parameters based on mode
- const queryParams = isPast24HoursMode
- ? {
- // Past minutes approach for last-24-hours mode
- timeZone: timeZone,
- pastMinutesStart: 24 * 60, // 24 hours ago
- pastMinutesEnd: 0, // now
- limit,
- page,
- percentile: selectedPercentile,
- filters: useFilters ? [...filters, ...additionalFilters] : undefined,
- sortBy,
- sortOrder,
- }
- : {
- // Regular date-based approach
- ...getStartAndEndDate(time),
- timeZone: timeZone,
- limit,
- page,
- percentile: selectedPercentile,
- filters: useFilters ? [...filters, ...additionalFilters] : undefined,
- sortBy,
- sortOrder,
- };
-
- return useQuery({
- queryKey: [
- "performance-by-path",
- time,
- site,
- filters,
- selectedPercentile,
- limit,
- page,
- isPast24HoursMode ? "past-minutes" : "date-range",
- additionalFilters,
- sortBy,
- sortOrder,
- ],
- queryFn: async () => {
- const response = await authedFetch<{
- data: PaginatedPerformanceResponse;
- }>(`/performance/by-path/${site}`, queryParams);
- return response.data;
- },
- staleTime: Infinity,
- placeholderData: (_, query: any) => {
- if (!query?.queryKey) return undefined;
- const prevQueryKey = query.queryKey;
- const [, , prevSite] = prevQueryKey;
-
- if (prevSite === site) {
- return query.state.data;
- }
- return undefined;
- },
- enabled,
- });
-}
diff --git a/client/src/api/analytics/useGetPerformanceOverview.ts b/client/src/api/analytics/useGetPerformanceOverview.ts
index 7695ce641..d8fe3b888 100644
--- a/client/src/api/analytics/useGetPerformanceOverview.ts
+++ b/client/src/api/analytics/useGetPerformanceOverview.ts
@@ -33,7 +33,27 @@ export function useGetPerformanceOverview({
const { time, previousTime, filters } = useStore();
const { selectedPercentile } = usePerformanceStore();
const timeToUse = periodTime === "previous" ? previousTime : time;
- const { startDate, endDate } = getStartAndEndDate(timeToUse);
+
+ // Check if we're using last-24-hours mode
+ const isPast24HoursMode = timeToUse.mode === "last-24-hours";
+
+ // Determine the query parameters based on mode
+ const queryParams = isPast24HoursMode
+ ? {
+ // Past minutes approach for last-24-hours mode
+ timeZone,
+ pastMinutesStart: 24 * 60, // 24 hours ago
+ pastMinutesEnd: 0, // now
+ filters,
+ percentile: selectedPercentile,
+ }
+ : {
+ // Regular date-based approach
+ ...getStartAndEndDate(timeToUse),
+ timeZone,
+ filters,
+ percentile: selectedPercentile,
+ };
return useQuery({
queryKey: [
@@ -42,17 +62,12 @@ export function useGetPerformanceOverview({
site,
filters,
selectedPercentile,
+ isPast24HoursMode ? "past-minutes" : "date-range",
],
queryFn: () => {
return authedFetch<{ data: GetPerformanceOverviewResponse }>(
`/performance/overview/${site}`,
- {
- startDate,
- endDate,
- timeZone,
- filters,
- percentile: selectedPercentile,
- }
+ queryParams
);
},
staleTime: Infinity,
diff --git a/client/src/api/analytics/useGetPerformanceTimeSeries.ts b/client/src/api/analytics/useGetPerformanceTimeSeries.ts
index 221239f29..666d84553 100644
--- a/client/src/api/analytics/useGetPerformanceTimeSeries.ts
+++ b/client/src/api/analytics/useGetPerformanceTimeSeries.ts
@@ -63,10 +63,29 @@ export function useGetPerformanceTimeSeries({
const timeToUse = periodTime === "previous" ? previousTime : time;
const bucketToUse = bucket || storeBucket;
- const { startDate, endDate } = getStartAndEndDate(timeToUse);
+ // Check if we're using last-24-hours mode
+ const isPast24HoursMode = timeToUse.mode === "last-24-hours";
const combinedFilters = [...globalFilters, ...dynamicFilters];
+ // Determine the query parameters based on mode
+ const queryParams = isPast24HoursMode
+ ? {
+ // Past minutes approach for last-24-hours mode
+ timeZone,
+ pastMinutesStart: 24 * 60, // 24 hours ago
+ pastMinutesEnd: 0, // now
+ bucket: bucketToUse,
+ filters: combinedFilters,
+ }
+ : {
+ // Regular date-based approach
+ ...getStartAndEndDate(timeToUse),
+ timeZone,
+ bucket: bucketToUse,
+ filters: combinedFilters,
+ };
+
return useQuery({
queryKey: [
"performance-time-series",
@@ -75,17 +94,12 @@ export function useGetPerformanceTimeSeries({
site,
combinedFilters,
selectedPerformanceMetric,
+ isPast24HoursMode ? "past-minutes" : "date-range",
],
queryFn: () => {
return authedFetch<APIResponse<GetPerformanceTimeSeriesResponse>>(
`/performance/time-series/${site}`,
- {
- startDate,
- endDate,
- timeZone,
- bucket: bucketToUse,
- filters: combinedFilters,
- }
+ queryParams
);
},
placeholderData: (_, query: any) => {
diff --git a/memory-bank/decisionLog.md b/memory-bank/decisionLog.md
index ee2deb6fc..8810b27de 100644
--- a/memory-bank/decisionLog.md
+++ b/memory-bank/decisionLog.md
@@ -60,3 +60,23 @@ User feedback indicated they didn't like the overloading behavior and wanted the
- Second parameter is now always `params?: Record<string, any>`
- Third parameter remains `config: AxiosRequestConfig = {}` for advanced axios options
- Simplified function body to always treat second argument as query parameters
+
+[2025-06-08 19:13:30] - Added past 24-hour mode support to performance analytics hooks
+
+## Rationale
+
+User requested to add support for the past 24-hour mode to useGetPerformanceTimeSeries and useGetPerformanceOverview hooks, following the same pattern already implemented in useGetPerformanceByDimension. This decision was made to:
+
+- Provide consistent API behavior across all performance analytics hooks
+- Support real-time analytics for the last 24 hours using pastMinutes parameters
+- Maintain backward compatibility with existing date-range based queries
+- Ensure proper query key differentiation between different time modes
+
+## Implementation Details
+
+- Modified useGetPerformanceTimeSeries to detect `time.mode === "last-24-hours"`
+- Modified useGetPerformanceOverview to detect `time.mode === "last-24-hours"`
+- Added conditional query parameter logic using pastMinutesStart/pastMinutesEnd for 24-hour mode
+- Updated query keys to include mode differentiation ("past-minutes" vs "date-range")
+- Maintained existing date-based approach for all other time modes
+- Used same pattern as useGetPerformanceByDimension for consistency
diff --git a/memory-bank/progress.md b/memory-bank/progress.md
index d7fd06059..0141d0c09 100644
--- a/memory-bank/progress.md
+++ b/memory-bank/progress.md
@@ -95,3 +95,12 @@ This file tracks the project's progress using a task list format.
- Significantly expanded Shopify guide ([`docs/src/content/guides/shopify.mdx`](docs/src/content/guides/shopify.mdx:1)) with e-commerce event tracking.
- Expanded Framer guide ([`docs/src/content/guides/framer.mdx`](docs/src/content/guides/framer.mdx:1)) and Webflow guide ([`docs/src/content/guides/webflow.mdx`](docs/src/content/guides/webflow.mdx:1)) with notes on SPA behavior and custom event tracking.
- Corrected minor inconsistencies in Hugo and Jekyll guides.
+
+2025-06-08 19:13:40 - Added past 24-hour mode support to performance analytics hooks
+
+- Modified [`useGetPerformanceTimeSeries.ts`](client/src/api/analytics/useGetPerformanceTimeSeries.ts:1) to support last-24-hours mode
+- Modified [`useGetPerformanceOverview.ts`](client/src/api/analytics/useGetPerformanceOverview.ts:1) to support last-24-hours mode
+- Implemented conditional query parameter logic using pastMinutesStart/pastMinutesEnd for 24-hour mode
+- Updated query keys to differentiate between "past-minutes" and "date-range" modes
+- Maintained backward compatibility with existing date-range based queries
+- Achieved consistency across all performance analytics hooks
diff --git a/server/src/api/analytics/getPerformanceByPath.ts b/server/src/api/analytics/getPerformanceByPath.ts
deleted file mode 100644
index 08a8b06c7..000000000
--- a/server/src/api/analytics/getPerformanceByPath.ts
+++ /dev/null
@@ -1,267 +0,0 @@
-import { FastifyReply, FastifyRequest } from "fastify";
-import clickhouse from "../../db/clickhouse/clickhouse.js";
-import { getUserHasAccessToSitePublic } from "../../lib/auth-utils.js";
-import {
- getFilterStatement,
- getTimeStatement,
- processResults,
-} from "./utils.js";
-import { PerformanceByPathItem } from "./types.js";
-
-interface GetPerformanceByPathRequest {
- Params: {
- site: string;
- };
- Querystring: {
- startDate: string;
- endDate: string;
- pastMinutesStart?: number;
- pastMinutesEnd?: number;
- timeZone: string;
- filters: string;
- limit?: number;
- page?: number;
- sortBy?: string;
- sortOrder?: "asc" | "desc";
- };
-}
-
-// This is the structure the API will now send
-type GetPerformanceByPathPaginatedResponse = {
- data: PerformanceByPathItem[];
- totalCount: number;
-};
-
-const getQuery = (
- request: FastifyRequest<GetPerformanceByPathRequest>,
- isCountQuery: boolean = false
-) => {
- const {
- startDate,
- endDate,
- timeZone,
- filters,
- limit,
- page,
- pastMinutesStart,
- pastMinutesEnd,
- sortBy,
- sortOrder,
- } = request.query;
-
- const filterStatement = getFilterStatement(filters);
-
- // Handle specific past minutes range if provided
- const pastMinutesRange =
- pastMinutesStart && pastMinutesEnd
- ? { start: Number(pastMinutesStart), end: Number(pastMinutesEnd) }
- : undefined;
-
- const timeStatement = getTimeStatement(
- pastMinutesRange
- ? { pastMinutesRange }
- : {
- date: { startDate, endDate, timeZone },
- }
- );
-
- let validatedLimit: number | null = null;
- if (!isCountQuery && limit !== undefined) {
- const parsedLimit = parseInt(String(limit), 10);
- if (!isNaN(parsedLimit) && parsedLimit > 0) {
- validatedLimit = parsedLimit;
- }
- }
- const limitStatement =
- !isCountQuery && validatedLimit
- ? `LIMIT ${validatedLimit}`
- : isCountQuery
- ? ""
- : "LIMIT 100";
-
- let validatedOffset: number | null = null;
- if (!isCountQuery && page !== undefined) {
- const parsedPage = parseInt(String(page), 10);
- if (!isNaN(parsedPage) && parsedPage >= 1) {
- const pageOffset = (parsedPage - 1) * (validatedLimit || 100);
- validatedOffset = pageOffset;
- }
- }
- const offsetStatement =
- !isCountQuery && validatedOffset ? `OFFSET ${validatedOffset}` : "";
-
- // Handle sorting
- const validSortColumns = [
- "pathname",
- "event_count",
- "lcp_avg",
- "lcp_p50",
- "lcp_p75",
- "lcp_p90",
- "lcp_p99",
- "cls_avg",
- "cls_p50",
- "cls_p75",
- "cls_p90",
- "cls_p99",
- "inp_avg",
- "inp_p50",
- "inp_p75",
- "inp_p90",
- "inp_p99",
- "fcp_avg",
- "fcp_p50",
- "fcp_p75",
- "fcp_p90",
- "fcp_p99",
- "ttfb_avg",
- "ttfb_p50",
- "ttfb_p75",
- "ttfb_p90",
- "ttfb_p99",
- ];
- const validSortBy =
- sortBy && validSortColumns.includes(sortBy) ? sortBy : "event_count";
- const validSortOrder = sortOrder === "asc" ? "ASC" : "DESC";
- const orderByStatement = !isCountQuery
- ? `ORDER BY ${validSortBy} ${validSortOrder} NULLS LAST`
- : "";
-
- const baseCteQuery = `
- PerformanceStats AS (
- SELECT
- pathname,
- COUNT(*) as event_count,
- avgIf(lcp, lcp IS NOT NULL) as lcp_avg,
- quantileIf(0.5)(lcp, lcp IS NOT NULL) as lcp_p50,
- quantileIf(0.75)(lcp, lcp IS NOT NULL) as lcp_p75,
- quantileIf(0.9)(lcp, lcp IS NOT NULL) as lcp_p90,
- quantileIf(0.99)(lcp, lcp IS NOT NULL) as lcp_p99,
- avgIf(cls, cls IS NOT NULL) as cls_avg,
- quantileIf(0.5)(cls, cls IS NOT NULL) as cls_p50,
- quantileIf(0.75)(cls, cls IS NOT NULL) as cls_p75,
- quantileIf(0.9)(cls, cls IS NOT NULL) as cls_p90,
- quantileIf(0.99)(cls, cls IS NOT NULL) as cls_p99,
- avgIf(inp, inp IS NOT NULL) as inp_avg,
- quantileIf(0.5)(inp, inp IS NOT NULL) as inp_p50,
- quantileIf(0.75)(inp, inp IS NOT NULL) as inp_p75,
- quantileIf(0.9)(inp, inp IS NOT NULL) as inp_p90,
- quantileIf(0.99)(inp, inp IS NOT NULL) as inp_p99,
- avgIf(fcp, fcp IS NOT NULL) as fcp_avg,
- quantileIf(0.5)(fcp, fcp IS NOT NULL) as fcp_p50,
- quantileIf(0.75)(fcp, fcp IS NOT NULL) as fcp_p75,
- quantileIf(0.9)(fcp, fcp IS NOT NULL) as fcp_p90,
- quantileIf(0.99)(fcp, fcp IS NOT NULL) as fcp_p99,
- avgIf(ttfb, ttfb IS NOT NULL) as ttfb_avg,
- quantileIf(0.5)(ttfb, ttfb IS NOT NULL) as ttfb_p50,
- quantileIf(0.75)(ttfb, ttfb IS NOT NULL) as ttfb_p75,
- quantileIf(0.9)(ttfb, ttfb IS NOT NULL) as ttfb_p90,
- quantileIf(0.99)(ttfb, ttfb IS NOT NULL) as ttfb_p99
- FROM events
- WHERE
- site_id = {siteId:Int32}
- AND type = 'performance'
- AND pathname IS NOT NULL
- AND pathname <> ''
- ${filterStatement}
- ${timeStatement}
- GROUP BY pathname
- )
- `;
-
- if (isCountQuery) {
- return `
- WITH ${baseCteQuery}
- SELECT COUNT(DISTINCT pathname) as totalCount FROM PerformanceStats;
- `;
- }
-
- return `
- WITH ${baseCteQuery}
- SELECT
- pathname,
- event_count,
- lcp_avg,
- lcp_p50,
- lcp_p75,
- lcp_p90,
- lcp_p99,
- cls_avg,
- cls_p50,
- cls_p75,
- cls_p90,
- cls_p99,
- inp_avg,
- inp_p50,
- inp_p75,
- inp_p90,
- inp_p99,
- fcp_avg,
- fcp_p50,
- fcp_p75,
- fcp_p90,
- fcp_p99,
- ttfb_avg,
- ttfb_p50,
- ttfb_p75,
- ttfb_p90,
- ttfb_p99
- FROM PerformanceStats
- ${orderByStatement}
- ${limitStatement}
- ${offsetStatement};
- `;
-};
-
-export async function getPerformanceByPath(
- req: FastifyRequest<GetPerformanceByPathRequest>,
- res: FastifyReply
-) {
- const { page } = req.query;
- const site = req.params.site;
-
- const userHasAccessToSite = await getUserHasAccessToSitePublic(req, site);
- if (!userHasAccessToSite) {
- return res.status(403).send({ error: "Forbidden" });
- }
-
- const isPaginatedRequest = page !== undefined;
-
- const dataQuery = getQuery(req, false);
- const countQuery = getQuery(req, true);
-
- try {
- // Run both queries in parallel
- const [dataResult, countResult] = await Promise.all([
- clickhouse.query({
- query: dataQuery,
- format: "JSONEachRow",
- query_params: {
- siteId: Number(site),
- },
- }),
- clickhouse.query({
- query: countQuery,
- format: "JSONEachRow",
- query_params: {
- siteId: Number(site),
- },
- }),
- ]);
-
- const items = await processResults<PerformanceByPathItem>(dataResult);
- const countData = await processResults<{ totalCount: number }>(countResult);
- const totalCount = countData.length > 0 ? countData[0].totalCount : 0;
-
- return res.send({ data: { data: items, totalCount } });
- } catch (error) {
- console.error("Error fetching performance by path:", error);
- console.error("Failed dataQuery:", dataQuery);
- if (isPaginatedRequest) {
- console.error("Failed countQuery:", countQuery);
- }
- return res
- .status(500)
- .send({ error: "Failed to fetch performance by path" });
- }
-}
diff --git a/server/src/api/analytics/getPerformanceTimeSeries.ts b/server/src/api/analytics/getPerformanceTimeSeries.ts
index eb6e7e272..68238a997 100644
--- a/server/src/api/analytics/getPerformanceTimeSeries.ts
+++ b/server/src/api/analytics/getPerformanceTimeSeries.ts
@@ -132,6 +132,7 @@ const getQuery = ({
const filterStatement = getFilterStatement(filters);
const isAllTime = !startDate && !endDate && !pastMinutesRange;
+ console.log(pastMinutesRange);
const timeParams = pastMinutesRange
? { pastMinutesRange }
@@ -173,6 +174,8 @@ GROUP BY time ORDER BY time ${
isAllTime ? "" : getTimeStatementFill(timeParams, bucket)
}`;
+ console.log(query);
+
return query;
};
diff --git a/server/src/index.ts b/server/src/index.ts
index cd56dffb2..b6b514096 100644
--- a/server/src/index.ts
+++ b/server/src/index.ts
@@ -24,7 +24,6 @@ import { getOrgEventCount } from "./api/analytics/getOrgEventCount.js";
import { getOverview } from "./api/analytics/getOverview.js";
import { getOverviewBucketed } from "./api/analytics/getOverviewBucketed.js";
import { getPageTitles } from "./api/analytics/getPageTitles.js";
-import { getPerformanceByPath } from "./api/analytics/getPerformanceByPath.js";
import { getPerformanceByDimension } from "./api/analytics/getPerformanceByDimension.js";
import { getPerformanceOverview } from "./api/analytics/getPerformanceOverview.js";
import { getPerformanceTimeSeries } from "./api/analytics/getPerformanceTimeSeries.js";
@@ -248,7 +247,6 @@ server.get("/api/org-event-count/:organizationId", getOrgEventCount);
// Performance Analytics
server.get("/api/performance/overview/:site", getPerformanceOverview);
server.get("/api/performance/time-series/:site", getPerformanceTimeSeries);
-server.get("/api/performance/by-path/:site", getPerformanceByPath);
server.get("/api/performance/by-dimension/:site", getPerformanceByDimension);
// Administrative