Skip to content

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

Refactor analytics data fetching to support past minutes query

Bill Yang770feae461de
diff --git a/client/src/api/analytics/useGetOverviewBucketed.ts b/client/src/api/analytics/useGetOverviewBucketed.ts
index 5c11eb0af..82464b662 100644
--- a/client/src/api/analytics/useGetOverviewBucketed.ts
+++ b/client/src/api/analytics/useGetOverviewBucketed.ts
@@ -18,11 +18,9 @@ export type GetOverviewBucketedResponse = {
export function useGetOverviewBucketed({
periodTime,
- past24Hours,
site,
}: {
periodTime?: PeriodTime;
- past24Hours?: boolean;
site?: number | string;
}): UseQueryResult<APIResponse<GetOverviewBucketedResponse>> {
const { time, previousTime, bucket, filters } = useStore();
@@ -32,14 +30,7 @@ export function useGetOverviewBucketed({
const { startDate, endDate } = getStartAndEndDate(timeToUse);
return useQuery({
- queryKey: [
- "overview-bucketed",
- timeToUse,
- bucket,
- site,
- filters,
- past24Hours,
- ],
+ queryKey: ["overview-bucketed", timeToUse, bucket, site, filters],
queryFn: () => {
const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
return authedFetch(`${BACKEND_URL}/overview-bucketed`, {
@@ -49,7 +40,40 @@ export function useGetOverviewBucketed({
bucket,
site,
filters,
- past24Hours,
+ }).then((res) => res.json());
+ },
+ placeholderData: (_, query: any) => {
+ if (!query?.queryKey) return undefined;
+ const prevQueryKey = query.queryKey as [string, string, string];
+ const [, , prevSite] = prevQueryKey;
+
+ if (prevSite === site) {
+ return query.state.data;
+ }
+ return undefined;
+ },
+ staleTime: Infinity,
+ });
+}
+
+export function useGetOverviewBucketedPastMinutes({
+ pastMinutes = 24 * 60,
+ site,
+}: {
+ pastMinutes: number;
+ site?: number | string;
+}): UseQueryResult<APIResponse<GetOverviewBucketedResponse>> {
+ const { bucket, filters } = useStore();
+
+ return useQuery({
+ queryKey: ["overview-bucketed-past-minutes", pastMinutes, site, filters],
+ queryFn: () => {
+ const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+ return authedFetch(`${BACKEND_URL}/overview-bucketed`, {
+ timezone,
+ bucket,
+ site,
+ pastMinutes,
}).then((res) => res.json());
},
placeholderData: (_, query: any) => {
diff --git a/client/src/components/SiteCard.tsx b/client/src/components/SiteCard.tsx
index 90c9e0158..e48aa048e 100644
--- a/client/src/components/SiteCard.tsx
+++ b/client/src/components/SiteCard.tsx
@@ -1,7 +1,7 @@
import { ArrowRight } from "lucide-react";
import Link from "next/link";
import { useGetOverviewPastMinutes } from "../api/analytics/useGetOverview";
-import { useGetOverviewBucketed } from "../api/analytics/useGetOverviewBucketed";
+import { useGetOverviewBucketedPastMinutes } from "../api/analytics/useGetOverviewBucketed";
import { SiteSessionChart } from "./SiteSessionChart";
import { SiteSettings } from "./SiteSettings/SiteSettings";
import { Button } from "./ui/button";
@@ -13,8 +13,8 @@ interface SiteCardProps {
}
export function SiteCard({ siteId, domain }: SiteCardProps) {
- const { data, isLoading } = useGetOverviewBucketed({
- past24Hours: true,
+ const { data, isLoading } = useGetOverviewBucketedPastMinutes({
+ pastMinutes: 24 * 60,
site: siteId,
});
diff --git a/server/src/api/getOverview.ts b/server/src/api/getOverview.ts
index 8b1e164a8..7ae7307a0 100644
--- a/server/src/api/getOverview.ts
+++ b/server/src/api/getOverview.ts
@@ -100,8 +100,7 @@ export interface GenericRequest {
site: string;
filters: string;
parameter: FilterParameter;
- past24Hours: boolean;
- pastMinutes: number;
+ pastMinutes?: number;
limit?: number;
};
}
diff --git a/server/src/api/getOverviewBucketed.ts b/server/src/api/getOverviewBucketed.ts
index 30d3b065b..9e87dbeaa 100644
--- a/server/src/api/getOverviewBucketed.ts
+++ b/server/src/api/getOverviewBucketed.ts
@@ -32,23 +32,34 @@ const bucketIntervalMap = {
} as const;
function getTimeStatementFill(
- startDate: string,
- endDate: string,
- timezone: string,
+ {
+ date,
+ pastMinutes,
+ }: {
+ date?: { startDate: string; endDate: string; timezone: string };
+ pastMinutes?: number;
+ },
bucket: TimeBucket
) {
- return `WITH FILL FROM toTimeZone(
+ if (date) {
+ const { startDate, endDate, timezone } = date;
+ return `WITH FILL FROM toTimeZone(
toStartOfDay(toDateTime('${startDate}', '${timezone}')),
'UTC'
- )
- TO if(
- toDate('${endDate}') = toDate(now(), '${timezone}'),
- now(),
- toTimeZone(
- toStartOfDay(toDateTime('${endDate}', '${timezone}')) + INTERVAL 1 DAY,
- 'UTC'
)
- ) STEP INTERVAL ${bucketIntervalMap[bucket]}`;
+ TO if(
+ toDate('${endDate}') = toDate(now(), '${timezone}'),
+ now(),
+ toTimeZone(
+ toStartOfDay(toDateTime('${endDate}', '${timezone}')) + INTERVAL 1 DAY,
+ 'UTC'
+ )
+ ) STEP INTERVAL ${bucketIntervalMap[bucket]}`;
+ }
+ if (pastMinutes) {
+ return `WITH FILL FROM now() - INTERVAL ${pastMinutes} MINUTE TO now() STEP INTERVAL ${bucketIntervalMap[bucket]}`;
+ }
+ return "";
}
const getQuery = ({
@@ -58,7 +69,7 @@ const getQuery = ({
bucket,
site,
filters,
- past24Hours,
+ pastMinutes,
}: {
startDate: string;
endDate: string;
@@ -66,79 +77,14 @@ const getQuery = ({
bucket: TimeBucket;
site: string;
filters: string;
- past24Hours: boolean;
+ pastMinutes?: number;
}) => {
const filterStatement = getFilterStatement(filters);
- if (past24Hours) {
- return `SELECT
- session_stats.time AS time,
- 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 STATS β€”β€”β€”β€”β€” */
- SELECT
- ${TimeBucketToFn[bucket]}(toTimeZone(start_time, '${timezone}')) AS time,
- 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(*) AS pages_in_session
- 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'
- GROUP BY session_id
- )
- GROUP BY time
- ORDER BY time WITH FILL
- FROM toTimeZone(${TimeBucketToFn[bucket]}(now('${timezone}') - INTERVAL 1 DAY), 'UTC')
- TO toTimeZone(${TimeBucketToFn[bucket]}(now('${timezone}')), 'UTC')
- STEP INTERVAL 1 HOUR
-) AS session_stats
-
-FULL JOIN
-(
- /* β€”β€”β€”β€”β€” PAGE STATS β€”β€”β€”β€”β€” */
- SELECT
- ${TimeBucketToFn[bucket]}(toTimeZone(timestamp, '${timezone}')) AS time,
- COUNT(*) AS pageviews,
- COUNT(DISTINCT user_id) 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'
- GROUP BY time
- ORDER BY time WITH FILL
- FROM toTimeZone(${TimeBucketToFn[bucket]}(now('${timezone}') - INTERVAL 1 DAY), 'UTC')
- TO toTimeZone(${TimeBucketToFn[bucket]}(now('${timezone}')), 'UTC')
- STEP INTERVAL 1 HOUR
-) AS page_stats
-
-USING time
-ORDER BY time;`;
- }
const isAllTime = !startDate && !endDate;
- const query = `SELECT
+ const query = `
+SELECT
session_stats.time AS time,
session_stats.sessions,
session_stats.pages_per_session,
@@ -146,7 +92,7 @@ ORDER BY time;`;
session_stats.session_duration,
page_stats.pageviews,
page_stats.users
-FROM
+FROM
(
SELECT
${
@@ -168,16 +114,25 @@ FROM
WHERE
site_id = ${site}
${filterStatement}
- ${getTimeStatement({
- date: { startDate, endDate, timezone },
- })}
+ ${getTimeStatement(
+ pastMinutes
+ ? { pastMinutes }
+ : {
+ date: { startDate, endDate, timezone },
+ }
+ )}
AND type = 'pageview'
GROUP BY session_id
)
GROUP BY time ORDER BY time ${
isAllTime
? ""
- : getTimeStatementFill(startDate, endDate, timezone, bucket)
+ : getTimeStatementFill(
+ pastMinutes
+ ? { pastMinutes }
+ : { date: { startDate, endDate, timezone } },
+ bucket
+ )
}
) AS session_stats
FULL JOIN
@@ -192,14 +147,23 @@ FULL JOIN
WHERE
site_id = ${site}
${filterStatement}
- ${getTimeStatement({
- date: { startDate, endDate, timezone },
- })}
+ ${getTimeStatement(
+ pastMinutes
+ ? { pastMinutes }
+ : {
+ date: { startDate, endDate, timezone },
+ }
+ )}
AND type = 'pageview'
GROUP BY time ORDER BY time ${
isAllTime
? ""
- : getTimeStatementFill(startDate, endDate, timezone, bucket)
+ : getTimeStatementFill(
+ pastMinutes
+ ? { pastMinutes }
+ : { date: { startDate, endDate, timezone } },
+ bucket
+ )
}
) AS page_stats
USING time
@@ -221,12 +185,12 @@ export async function getOverviewBucketed(
bucket: TimeBucket;
site: string;
filters: string;
- past24Hours?: boolean;
+ pastMinutes?: number;
};
}>,
res: FastifyReply
) {
- const { startDate, endDate, timezone, bucket, site, filters, past24Hours } =
+ const { startDate, endDate, timezone, bucket, site, filters, pastMinutes } =
req.query;
const userHasAccessToSite = await getUserHasAccessToSite(req, site);
@@ -241,9 +205,11 @@ export async function getOverviewBucketed(
bucket,
site,
filters,
- past24Hours: past24Hours ?? false,
+ pastMinutes,
});
+ console.info(query);
+
try {
const result = await clickhouse.query({
query,