Skip to content

Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.

feat: add individual visitor's bar chart

Marc Seitz1c768152a9e2
diff --git a/components/charts/bar-chart.tsx b/components/charts/bar-chart.tsx
index b37c1418..e7b4b7f5 100644
--- a/components/charts/bar-chart.tsx
+++ b/components/charts/bar-chart.tsx
@@ -21,8 +21,18 @@ const renameAvgDurationKey = (data: any[]) => {
});
};
-export default function BarChartComponent({data}: {data: any}) {
- const renamedData = renameAvgDurationKey(data);
+const renameSumDurationKey = (data: any[]) => {
+ return data.map((item) => {
+ return {
+ ...item,
+ "Time spent per page": item.sum_duration,
+ sum_duration: undefined,
+ };
+ });
+};
+
+export default function BarChartComponent({data, isSum = false}: {data: any, isSum?: boolean}) {
+ const renamedData = isSum ? renameSumDurationKey(data) : renameAvgDurationKey(data);
return (
<BarChart
diff --git a/components/visitors/visitor-chart.tsx b/components/visitors/visitor-chart.tsx
new file mode 100644
index 00000000..e20d45ed
--- /dev/null
+++ b/components/visitors/visitor-chart.tsx
@@ -0,0 +1,45 @@
+import { useVisitorStats } from "@/lib/swr/use-stats";
+import ErrorPage from "next/error";
+import BarChartComponent from "@/components/charts/bar-chart";
+
+export default function VisitorChart({
+ documentId,
+ viewId,
+ totalPages = 0,
+}: {
+ documentId: string;
+ viewId: string;
+ totalPages?: number;
+}) {
+ const { stats, error } = useVisitorStats(viewId);
+
+ if (error && error.status === 404) {
+ return <ErrorPage statusCode={404} />;
+ }
+
+ if (!stats?.duration.data) {
+ return <div>No data</div>;
+ }
+
+ let durationData = {
+ data: Array.from({ length: totalPages }, (_, i) => ({
+ pageNumber: (i + 1).toString(),
+ sum_duration: 0,
+ })),
+ };
+
+ const swrData = stats?.duration;
+
+ durationData.data = durationData.data.map((item) => {
+ const swrItem = swrData.data.find(
+ (data) => data.pageNumber === item.pageNumber
+ );
+ return swrItem ? swrItem : item;
+ });
+
+ return (
+ <div className="">
+ <BarChartComponent data={durationData.data} isSum={true} />
+ </div>
+ );
+}
diff --git a/components/visitors/visitors-table.tsx b/components/visitors/visitors-table.tsx
index 33d09d88..90ae2778 100644
--- a/components/visitors/visitors-table.tsx
+++ b/components/visitors/visitors-table.tsx
@@ -18,8 +18,9 @@ import { useDocumentVisits } from "@/lib/swr/use-document";
import { durationFormat, nFormatter, timeAgo } from "@/lib/utils";
import { Skeleton } from "../ui/skeleton";
import ChevronDown from "../shared/icons/chevron-down";
+import VisitorChart from "./visitor-chart";
-export default function VisitorsTable() {
+export default function VisitorsTable({numPages}: {numPages: number}) {
const { views } = useDocumentVisits();
return (
@@ -106,6 +107,11 @@ export default function VisitorsTable() {
<TableRow className="hover:bg-transparent">
<TableCell colSpan={5}>
<div>
+ <VisitorChart
+ documentId={view.documentId}
+ viewId={view.id}
+ totalPages={numPages}
+ />
</div>
</TableCell>
</TableRow>
diff --git a/lib/swr/use-stats.ts b/lib/swr/use-stats.ts
index d2920b41..6a404ecb 100644
--- a/lib/swr/use-stats.ts
+++ b/lib/swr/use-stats.ts
@@ -18,6 +18,7 @@ interface StatsData {
}
export function useStats() {
+ // this gets the data for a document's graph of all views
const router = useRouter();
const { id } = router.query as {
@@ -38,3 +39,37 @@ export function useStats() {
error,
};
}
+
+interface StatsViewData {
+ views: View[];
+ duration: {
+ data: { pageNumber: string; sum_duration: number }[];
+ };
+}
+
+export function useVisitorStats(viewId: string) {
+ // this gets the data for a single visitor's graph
+ const router = useRouter();
+
+ const { id: documentId } = router.query as {
+ id: string;
+ };
+
+ const { data: stats, error } = useSWR<StatsViewData>(
+ documentId &&
+ viewId &&
+ `/api/documents/${encodeURIComponent(documentId)}/views/${encodeURIComponent(
+ viewId
+ )}/stats`,
+ fetcher,
+ {
+ dedupingInterval: 10000,
+ }
+ );
+
+ return {
+ stats,
+ loading: !error && !stats,
+ error,
+ };
+}
\ No newline at end of file
diff --git a/pages/api/documents/[id]/views/[viewId]/stats.ts b/pages/api/documents/[id]/views/[viewId]/stats.ts
new file mode 100644
index 00000000..1d1bf809
--- /dev/null
+++ b/pages/api/documents/[id]/views/[viewId]/stats.ts
@@ -0,0 +1,48 @@
+import { NextApiRequest, NextApiResponse } from "next";
+import { getServerSession } from "next-auth/next";
+import { getViewPageDuration } from "@/lib/tinybird";
+import { authOptions } from "@/pages/api/auth/[...nextauth]";
+
+export default async function handle(
+ req: NextApiRequest,
+ res: NextApiResponse
+) {
+ if (req.method === "GET") {
+ // GET /api/documents/:id/views/:viewId/stats
+ const session = await getServerSession(req, res, authOptions);
+ if (!session) {
+ return res.status(401).end("Unauthorized");
+ }
+
+ const { id, viewId } = req.query as { id: string, viewId: string };
+
+ try {
+
+ const duration = await getViewPageDuration({
+ documentId: id,
+ viewId: viewId,
+ since: 0,
+ });
+
+ const total_duration = duration.data.reduce(
+ (totalDuration, data) => totalDuration + data.sum_duration,
+ 0
+ );
+
+ const stats = { duration, total_duration };
+
+ // TODO: Check that the user is owner of the document, otherwise return 401
+
+ res.status(200).json(stats);
+ } catch (error) {
+ return res.status(500).json({
+ message: "Internal Server Error",
+ error: (error as Error).message,
+ });
+ }
+ } else {
+ // We only allow GET and POST requests
+ res.setHeader("Allow", ["GET"]);
+ return res.status(405).end(`Method ${req.method} Not Allowed`);
+ }
+}
diff --git a/pages/documents/[id].tsx b/pages/documents/[id].tsx
index ea5fb196..fa559307 100644
--- a/pages/documents/[id].tsx
+++ b/pages/documents/[id].tsx
@@ -57,7 +57,7 @@ export default function DocumentPage() {
)}
<StatsCard />
{/* Visitors */}
- <VisitorsTable />
+ <VisitorsTable numPages={document.numPages!} />
{/* Links */}
<LinksTable />
</>