🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.
Add bucketed events chart to the Events page (#814)
Chris Rimmer7575c4452078
diff --git a/client/src/api/analytics/endpoints/events.ts b/client/src/api/analytics/endpoints/events.tsindex 30bf32aeb..6feb3c8de 100644--- a/client/src/api/analytics/endpoints/events.ts+++ b/client/src/api/analytics/endpoints/events.ts@@ -1,5 +1,6 @@import { authedFetch } from "../../utils";-import { CommonApiParams, PaginationParams, toQueryParams } from "./types";+import { BucketedParams, CommonApiParams, PaginationParams, toBucketedQueryParams, toQueryParams } from "./types";+// Event typeexport type Event = {@@ -50,10 +51,22 @@ export type OutboundLink = {lastClicked: string;};+// Event counts over time+export type EventBucketedPoint = {+ time: string;+ event_name: string;+ event_count: number;+};+export interface EventsParams extends CommonApiParams, PaginationParams {pageSize?: number;}+export interface EventBucketedParams extends BucketedParams {+ limit?: number;+}++export interface EventPropertiesParams extends CommonApiParams {eventName: string;}@@ -128,3 +141,24 @@ export async function fetchOutboundLinks();return response.data;}++/**+ * Fetch bucketed event counts for top custom events+ * GET /sites/:site/events/bucketed+ */+export async function fetchEventBucketed(+ site: string | number,+ params: EventBucketedParams+): Promise<EventBucketedPoint[]> {+ const queryParams = {+ ...toBucketedQueryParams(params),+ limit: params.limit,+ };++ const response = await authedFetch<{ data: EventBucketedPoint[] }>(+ `/sites/${site}/events/bucketed`,+ queryParams+ );+ return response.data;+}+diff --git a/client/src/api/analytics/endpoints/index.ts b/client/src/api/analytics/endpoints/index.tsindex 8a5eab070..f171400d2 100644--- a/client/src/api/analytics/endpoints/index.ts+++ b/client/src/api/analytics/endpoints/index.ts@@ -11,17 +11,20 @@ export type {} from "./overview";// Events endpoints-export { fetchEvents, fetchEventNames, fetchEventProperties, fetchOutboundLinks } from "./events";+export { fetchEventBucketed, fetchEvents, fetchEventNames, fetchEventProperties, fetchOutboundLinks } from "./events";export type {Event,+ EventBucketedPoint,EventsResponse,EventName,EventProperty,OutboundLink,+ EventBucketedParams,EventsParams,EventPropertiesParams,} from "./events";+// Errors endpointsexport { fetchErrorNames, fetchErrorEvents, fetchErrorBucketed } from "./errors";export type {diff --git a/client/src/api/analytics/hooks/events/useGetEventBucketed.ts b/client/src/api/analytics/hooks/events/useGetEventBucketed.tsnew file mode 100644index 000000000..4bd154207--- /dev/null+++ b/client/src/api/analytics/hooks/events/useGetEventBucketed.ts@@ -0,0 +1,25 @@+import { useQuery } from "@tanstack/react-query";+import { EVENT_FILTERS } from "../../../../lib/filterGroups";+import { getFilteredFilters, useStore } from "../../../../lib/store";+import { buildApiParams } from "../../../utils";+import { fetchEventBucketed } from "../../endpoints";++export function useGetEventBucketed({ limit = 5 }: { limit?: number } = {}) {+ const { site, time, bucket, timezone } = useStore();++ const filteredFilters = getFilteredFilters(EVENT_FILTERS);+ const params = buildApiParams(time, {+ filters: filteredFilters.length > 0 ? filteredFilters : undefined,+ });++ return useQuery({+ queryKey: ["event-bucketed", site, time, bucket, filteredFilters, limit, timezone],+ enabled: !!site,+ queryFn: () =>+ fetchEventBucketed(site, {+ ...params,+ bucket,+ limit,+ }),+ });+}diff --git a/client/src/app/[site]/events/components/EventsChart.tsx b/client/src/app/[site]/events/components/EventsChart.tsxnew file mode 100644index 000000000..11ab743b3--- /dev/null+++ b/client/src/app/[site]/events/components/EventsChart.tsx@@ -0,0 +1,294 @@+"use client";++import { ResponsiveLine, SliceTooltipProps } from "@nivo/line";+import { useWindowSize } from "@uidotdev/usehooks";+import { DateTime } from "luxon";+import { useEffect, useMemo, useState } from "react";++import { useGetEventBucketed } from "@/api/analytics/hooks/events/useGetEventBucketed";+import { BucketSelection } from "@/components/BucketSelection";+import { ChartTooltip } from "@/components/charts/ChartTooltip";+import { Card, CardContent, CardDescription, CardHeader, CardLoader, CardTitle } from "@/components/ui/card";+import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@/components/ui/select";+import { Skeleton } from "@/components/ui/skeleton";+import { formatChartDateTime, hour12, userLocale } from "@/lib/dateTimeUtils";+import { useNivoTheme } from "@/lib/nivo";+import { getTimezone, useStore } from "@/lib/store";+import { formatter } from "@/lib/utils";++const COLOR_PALETTE = [+ "hsl(var(--dataviz))",+ "hsl(var(--green-400))",+ "hsl(var(--amber-400))",+ "hsl(var(--red-400))",+ "hsl(var(--teal-400))",+ "hsl(var(--cyan-400))",+ "hsl(var(--orange-400))",+ "hsl(var(--blue-400))",+ "hsl(var(--indigo-400))",+ "hsl(var(--violet-400))",+];++const EVENT_LIMIT_OPTIONS = [1, 3, 5, 8, 10];++type EventPoint = {+ x: string;+ y: number;+ currentTime: DateTime;+};++type EventSeries = {+ id: string;+ color: string;+ data: EventPoint[];+};++export function EventsChart() {+ const { bucket } = useStore();+ const [eventLimit, setEventLimit] = useState(5);+ const { data, isLoading, isFetching } = useGetEventBucketed({ limit: eventLimit });+ const { width } = useWindowSize();+ const nivoTheme = useNivoTheme();+ const timezone = getTimezone();+ const [hiddenEventNames, setHiddenEventNames] = useState<Set<string>>(new Set());++ const toggleEventVisibility = (eventName: string) => {+ setHiddenEventNames(prev => {+ const next = new Set(prev);+ if (next.has(eventName)) {+ next.delete(eventName);+ } else {+ next.add(eventName);+ }+ return next;+ });+ };++ useEffect(() => {+ setHiddenEventNames(new Set());+ }, [eventLimit]);++ const { series, legendItems, maxValue, totalPoints } = useMemo(() => {+ if (!data || data.length === 0) {+ return { series: [] as EventSeries[], legendItems: [], maxValue: 1, totalPoints: 0 };+ }++ const timeLookup = new Map<string, DateTime>();+ const countsByEvent = new Map<string, Map<string, number>>();+ const totalsByEvent = new Map<string, number>();++ data.forEach(item => {+ const timestamp = DateTime.fromSQL(item.time, { zone: timezone }).toUTC();+ if (!timestamp.isValid || timestamp > DateTime.now().toUTC()) {+ return;+ }++ const timeKey = timestamp.toFormat("yyyy-MM-dd HH:mm:ss");+ timeLookup.set(timeKey, timestamp);++ if (!countsByEvent.has(item.event_name)) {+ countsByEvent.set(item.event_name, new Map());+ }++ countsByEvent.get(item.event_name)!.set(timeKey, item.event_count);+ totalsByEvent.set(item.event_name, (totalsByEvent.get(item.event_name) ?? 0) + item.event_count);+ });++ const sortedTimes = Array.from(timeLookup.entries()).sort((a, b) => a[1].toMillis() - b[1].toMillis());+ const sortedEventNames = Array.from(countsByEvent.keys()).sort(+ (a, b) => (totalsByEvent.get(b) ?? 0) - (totalsByEvent.get(a) ?? 0)+ );++ const seriesData = sortedEventNames.map((eventName, index) => {+ const counts = countsByEvent.get(eventName)!;+ return {+ id: eventName,+ color: COLOR_PALETTE[index % COLOR_PALETTE.length],+ data: sortedTimes.map(([timeKey, timeValue]) => ({+ x: timeKey,+ y: counts.get(timeKey) ?? 0,+ currentTime: timeValue,+ })),+ };+ });++ const values = seriesData.flatMap(serie => serie.data.map(point => point.y));+ const maxValue = values.length > 0 ? Math.max(...values) : 1;++ return {+ series: seriesData,+ legendItems: seriesData.map(serie => ({ id: serie.id, color: serie.color })),+ maxValue,+ totalPoints: sortedTimes.length,+ };+ }, [data, timezone]);++ const maxTicks = Math.round((width ?? 900) / 85);+ const visibleSeries = series.filter(serie => !hiddenEventNames.has(serie.id));+ const visibleValues = visibleSeries.flatMap(serie => serie.data.map(point => point.y));+ const visibleMaxValue = visibleValues.length > 0 ? Math.max(...visibleValues) : maxValue;+ const isAllHidden = series.length > 0 && visibleSeries.length === 0;++ const formatXAxisValue = (value: Date) => {+ const dt = DateTime.fromJSDate(value, { zone: "utc" }).setZone(timezone).setLocale(userLocale);+ if (["minute", "five_minutes", "ten_minutes", "fifteen_minutes", "hour"].includes(bucket)) {+ return dt.toFormat(hour12 ? "h:mm" : "HH:mm");+ }+ return dt.toFormat(hour12 ? "MMM d" : "dd MMM");+ };++ const controls = (+ <>+ <Select value={String(eventLimit)} onValueChange={value => setEventLimit(Number(value))}>+ <SelectTrigger className="w-[90px]" size="sm">+ <SelectValue />+ </SelectTrigger>+ <SelectContent size="sm">+ {EVENT_LIMIT_OPTIONS.map(option => (+ <SelectItem key={option} value={String(option)} size="sm">+ Top {option}+ </SelectItem>+ ))}+ </SelectContent>+ </Select>+ <BucketSelection />+ </>+ );++ return (+ <Card>+ {isFetching && <CardLoader />}+ <CardHeader className="flex flex-col gap-0 pb-1">+ <div className="flex items-start gap-2">+ <CardTitle className="flex-1">Custom Events Over Time</CardTitle>+ <div className="hidden items-center gap-2 sm:flex">{controls}</div>+ </div>+ <div className="mt-2 flex w-full flex-wrap items-center gap-2 sm:-mt-1">+ <CardDescription className="mt-0">{eventLimit === 1 ? "Top event" : `Top ${eventLimit} events`}</CardDescription>+ <div className="ml-auto flex items-center gap-2 sm:hidden">{controls}</div>+ </div>+ </CardHeader>+ <CardContent className="p-2 md:p-4 pt-0 pb-3 w-full space-y-3">++ {legendItems.length > 0 && (+ <div className="mt-2 md:mt-0 flex flex-wrap gap-3 px-2 md:px-0 text-xs text-neutral-500 dark:text-neutral-400">+ {legendItems.map(item => {+ const isHidden = hiddenEventNames.has(item.id);+ return (+ <button+ key={item.id}+ type="button"+ onClick={() => toggleEventVisibility(item.id)}+ className={`flex items-center gap-2 max-w-[200px] text-left transition-opacity cursor-pointer ${+ isHidden ? "opacity-40" : "opacity-100"+ }`}+ >+ <span className="h-2 w-2 rounded-full" style={{ backgroundColor: item.color }} />+ <span className={`truncate ${isHidden ? "line-through" : ""}`} title={item.id}>+ {item.id}+ </span>+ </button>+ );+ })}+ </div>+ )}++ {isLoading ? (+ <Skeleton className="w-full h-[260px] rounded-md" />+ ) : series.length === 0 ? (+ <div className="h-[260px] w-full flex items-center justify-center">+ <div className="text-center text-neutral-500">+ <p className="text-sm font-medium">No custom event data available</p>+ <p className="text-xs">Try adjusting your date range or filters</p>+ </div>+ </div>+ ) : isAllHidden ? (+ <div className="h-[260px] w-full flex items-center justify-center">+ <div className="text-center text-neutral-500">+ <p className="text-sm font-medium">All event series hidden</p>+ <p className="text-xs">Click a legend item to show it</p>+ </div>+ </div>+ ) : (+ <div className="h-[260px] w-full">+ <ResponsiveLine+ data={visibleSeries}+ theme={nivoTheme}+ margin={{ top: 10, right: 20, bottom: 30, left: 40 }}+ xScale={{+ type: "time",+ format: "%Y-%m-%d %H:%M:%S",+ precision: "second",+ useUTC: true,+ }}+ yScale={{+ type: "linear",+ min: 0,+ stacked: false,+ reverse: false,+ max: Math.max(visibleMaxValue, 1),+ }}+ enableGridX={true}+ enableGridY={true}+ gridYValues={5}+ axisTop={null}+ axisRight={null}+ axisBottom={{+ tickSize: 5,+ tickPadding: 10,+ tickRotation: 0,+ truncateTickAt: 0,+ tickValues: totalPoints > 0 ? Math.min(maxTicks, totalPoints) : undefined,+ format: formatXAxisValue,+ }}+ axisLeft={{+ tickSize: 5,+ tickPadding: 10,+ tickRotation: 0,+ truncateTickAt: 0,+ tickValues: 5,+ format: formatter,+ }}+ colors={datum => datum.color}+ enableTouchCrosshair={true}+ enablePoints={false}+ useMesh={true}+ animate={false}+ enableSlices="x"+ lineWidth={2}+ sliceTooltip={({ slice }: SliceTooltipProps<EventSeries>) => {+ const currentTime = slice.points[0]?.data.currentTime as DateTime | undefined;+ const sortedPoints = [...slice.points].sort(+ (a, b) => Number(b.data.yFormatted) - Number(a.data.yFormatted)+ );++ return (+ <ChartTooltip>+ <div className="p-3 min-w-[160px]">+ {currentTime && <div className="mb-2">{formatChartDateTime(currentTime, bucket)}</div>}+ <div className="space-y-1">+ {sortedPoints.map(point => (+ <div key={point.id} className="flex justify-between items-center gap-4">+ <div className="flex items-center gap-2">+ <div className="w-1 h-3 rounded-[3px]" style={{ backgroundColor: point.seriesColor }} />+ <span className="text-neutral-600 dark:text-neutral-300 max-w-[140px] truncate">+ {point.seriesId}+ </span>+ </div>+ <span className="font-medium text-neutral-700 dark:text-neutral-200">+ {formatter(Number(point.data.yFormatted))}+ </span>+ </div>+ ))}+ </div>+ </div>+ </ChartTooltip>+ );+ }}+ />+ </div>+ )}+ </CardContent>+ </Card>+ );+}diff --git a/client/src/app/[site]/events/page.tsx b/client/src/app/[site]/events/page.tsxindex 71c8b8ce2..5639a5e55 100644--- a/client/src/app/[site]/events/page.tsx+++ b/client/src/app/[site]/events/page.tsx@@ -8,6 +8,8 @@ import { useSetPageTitle } from "../../../hooks/useSetPageTitle";import { SubHeader } from "../components/SubHeader/SubHeader";import { EventList } from "./components/EventList";import { EventLog } from "./components/EventLog";+import { EventsChart } from "./components/EventsChart";+export default function EventsPage() {useSetPageTitle("Rybbit · Events");@@ -19,8 +21,11 @@ export default function EventsPage() {<div className="p-2 md:p-4 max-w-[1300px] mx-auto space-y-3"><SubHeader availableFilters={EVENT_FILTERS} />+ <EventsChart />+<Card className="h-auto lg:h-full"><CardHeader>+<CardTitle>Custom Events</CardTitle></CardHeader><CardContent>diff --git a/server/src/api/analytics/events/getEventBucketed.ts b/server/src/api/analytics/events/getEventBucketed.tsnew file mode 100644index 000000000..7f956cd24--- /dev/null+++ b/server/src/api/analytics/events/getEventBucketed.ts@@ -0,0 +1,97 @@+import { FilterParams } from "@rybbit/shared";+import { FastifyReply, FastifyRequest } from "fastify";+import { clickhouse } from "../../../db/clickhouse/clickhouse.js";+import { TimeBucket } from "../types.js";+import { getFilterStatement } from "../utils/getFilterStatement.js";+import { getTimeStatement, processResults, TimeBucketToFn } from "../utils/utils.js";++export type GetEventBucketedResponse = {+ time: string;+ event_name: string;+ event_count: number;+}[];++interface GetEventBucketedRequest {+ Params: {+ siteId: string;+ };+ Querystring: FilterParams<{+ bucket: TimeBucket;+ limit?: string;+ }>;+}++const parseLimit = (limit?: string) => {+ const parsed = Number(limit ?? 5);+ if (!Number.isFinite(parsed)) {+ return 5;+ }+ return Math.min(Math.max(Math.floor(parsed), 1), 10);+};++export async function getEventBucketed(req: FastifyRequest<GetEventBucketedRequest>, res: FastifyReply) {+ const site = req.params.siteId;+ const { bucket = "hour", limit } = req.query;+ const timeZone = req.query.time_zone || "UTC";++ if (!TimeBucketToFn[bucket]) {+ return res.status(400).send({ error: `Invalid bucket value: ${bucket}` });+ }++ const topLimit = parseLimit(limit);++ const timeStatement = getTimeStatement(req.query);+ const filterStatement = getFilterStatement(req.query.filters, Number(site), timeStatement);++ const query = `+ WITH top_events AS (+ SELECT+ event_name+ FROM events+ WHERE+ site_id = {siteId:Int32}+ AND type = 'custom_event'+ AND event_name IS NOT NULL+ AND event_name != ''+ ${timeStatement}+ ${filterStatement}+ GROUP BY event_name+ ORDER BY count() DESC+ LIMIT {limit:Int32}+ )+ SELECT+ toDateTime(${TimeBucketToFn[bucket]}(toTimeZone(timestamp, {timeZone:String}))) AS time,+ event_name,+ count() AS event_count+ FROM events+ WHERE+ site_id = {siteId:Int32}+ AND type = 'custom_event'+ AND event_name IS NOT NULL+ AND event_name != ''+ ${timeStatement}+ ${filterStatement}+ AND event_name IN (SELECT event_name FROM top_events)+ GROUP BY time, event_name+ ORDER BY time+ `;++ try {+ const result = await clickhouse.query({+ query,+ format: "JSONEachRow",+ query_params: {+ siteId: Number(site),+ limit: topLimit,+ timeZone,+ },+ });++ const data = await processResults<GetEventBucketedResponse[number]>(result);+ return res.send({ data });+ } catch (error) {+ console.error("Generated Query:", query);+ console.error("Error fetching bucketed event data:", error);+ return res.status(500).send({ error: "Failed to fetch bucketed event data" });+ }+}diff --git a/server/src/api/analytics/index.ts b/server/src/api/analytics/index.tsindex 102d865fc..6a69d0795 100644--- a/server/src/api/analytics/index.ts+++ b/server/src/api/analytics/index.ts@@ -1,9 +1,11 @@// Events+export { getEventBucketed } from "./events/getEventBucketed.js";export { getEventNames } from "./events/getEventNames.js";export { getEventProperties } from "./events/getEventProperties.js";export { getEvents } from "./events/getEvents.js";export { getOutboundLinks } from "./events/getOutboundLinks.js";+// Funnelsexport { createFunnel } from "./funnels/createFunnel.js";export { deleteFunnel } from "./funnels/deleteFunnel.js";diff --git a/server/src/index.ts b/server/src/index.tsindex 007e8c21a..d3e80fe3c 100644--- a/server/src/index.ts+++ b/server/src/index.ts@@ -19,9 +19,11 @@ import {getErrorBucketed,getErrorEvents,getErrorNames,+ getEventBucketed,getEventNames,getEventProperties,getEvents,+getFunnel,getFunnelStepSessions,getFunnels,@@ -237,7 +239,9 @@ async function analyticsRoutes(fastify: FastifyInstance) {fastify.get("/sites/:siteId/sessions", publicSite, getSessions);fastify.get("/sites/:siteId/sessions/:sessionId", publicSite, getSession);fastify.get("/sites/:siteId/events", publicSite, getEvents);+ fastify.get("/sites/:siteId/events/bucketed", publicSite, getEventBucketed);fastify.get("/sites/:siteId/users", publicSite, getUsers);+fastify.get("/sites/:siteId/users/session-count", publicSite, getUserSessionCount);fastify.get("/sites/:siteId/users/:userId", publicSite, getUserInfo);fastify.get("/sites/:siteId/session-locations", publicSite, getSessionLocations);