Skip to content

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

feat: add link visits api endpoint from tinybird to swr

Marc Seitz0a878e0dc3d9
diff --git a/lib/swr/use-link.ts b/lib/swr/use-link.ts
index 234d2b4e..776e78f2 100644
--- a/lib/swr/use-link.ts
+++ b/lib/swr/use-link.ts
@@ -2,6 +2,7 @@ import { useRouter } from "next/router";
import useSWR from "swr";
import { fetcher } from "@/lib/utils";
import { LinkWithDocument } from "../types";
+import { View } from "@prisma/client";
export function useLink() {
const router = useRouter();
@@ -24,3 +25,29 @@ export function useLink() {
error,
};
}
+
+interface ViewWithDuration extends View {
+ duration: {
+ data: { pageNumber: string; sum_duration: number }[];
+ };
+ totalDuration: number;
+ completionRate: number;
+}
+
+
+export function useLinkVisits(linkId: string) {
+
+ const { data: views, error } = useSWR<ViewWithDuration[]>(
+ linkId && `/api/links/${encodeURIComponent(linkId)}/visits`,
+ fetcher,
+ {
+ dedupingInterval: 10000,
+ }
+ );
+
+ return {
+ views,
+ loading: !error && !views,
+ error,
+ };
+}
\ No newline at end of file
diff --git a/lib/tinybird/endpoints/get_page_duration_per_view.pipe b/lib/tinybird/endpoints/get_page_duration_per_view.pipe
index 9072503a..b6b89e18 100644
--- a/lib/tinybird/endpoints/get_page_duration_per_view.pipe
+++ b/lib/tinybird/endpoints/get_page_duration_per_view.pipe
@@ -1,11 +1,11 @@
-VERSION 1
+VERSION 2
NODE endpoint
SQL >
%
SELECT
pageNumber,
- AVG(duration) AS avg_duration
+ SUM(duration) AS sum_duration
FROM
page_views__v1
WHERE
diff --git a/lib/tinybird/pipes.ts b/lib/tinybird/pipes.ts
index 2b35b8d0..ae892958 100644
--- a/lib/tinybird/pipes.ts
+++ b/lib/tinybird/pipes.ts
@@ -17,7 +17,7 @@ export const getTotalAvgPageDuration = tb.buildPipe({
});
export const getViewPageDuration = tb.buildPipe({
- pipe: "get_page_duration_per_view__v1",
+ pipe: "get_page_duration_per_view__v2",
parameters: z.object({
documentId: z.string(),
viewId: z.string(),
@@ -25,6 +25,6 @@ export const getViewPageDuration = tb.buildPipe({
}),
data: z.object({
pageNumber: z.string(),
- avg_duration: z.number(),
+ sum_duration: z.number(),
}),
});
\ No newline at end of file
diff --git a/pages/api/links/[id]/visits.ts b/pages/api/links/[id]/visits.ts
new file mode 100644
index 00000000..1d73d529
--- /dev/null
+++ b/pages/api/links/[id]/visits.ts
@@ -0,0 +1,95 @@
+import { NextApiRequest, NextApiResponse } from "next";
+import { getServerSession } from "next-auth/next";
+import prisma from "@/lib/prisma";
+import { authOptions } from "../../auth/[...nextauth]";
+import { log } from "@/lib/utils";
+import { getViewPageDuration } from "@/lib/tinybird";
+
+export default async function handle(
+ req: NextApiRequest,
+ res: NextApiResponse
+) {
+ if (req.method === "GET") {
+ // GET /api/links/:id/visits
+ const session = await getServerSession(req, res, authOptions);
+ if (!session) {
+ return res.status(401).end("Unauthorized");
+ }
+
+ // get link id from query params
+ const { id } = req.query as { id: string };
+
+ try {
+ // get the numPages from document
+ const result = await prisma.link.findUnique({
+ where: {
+ id: id,
+ },
+ select: {
+ document: {
+ select: {
+ numPages: true,
+ },
+ },
+ },
+ });
+ const numPages = result?.document?.numPages;
+
+ const views = await prisma.view.findMany({
+ where: {
+ linkId: id,
+ },
+ orderBy: {
+ viewedAt: "desc",
+ },
+ });
+
+ const durationsPromises = views.map((view) => {
+ return getViewPageDuration({
+ documentId: view.documentId,
+ viewId: view.id,
+ since: 0,
+ });
+ });
+
+ const durations = await Promise.all(durationsPromises);
+
+ // Sum up durations for each view
+ const summedDurations = durations.map((duration) => {
+ return duration.data.reduce(
+ (totalDuration, data) => totalDuration + data.sum_duration,
+ 0
+ );
+ });
+
+ // Construct the response combining views and their respective durations
+ const viewsWithDuration = views.map((view, index) => {
+ // calculate the completion rate
+ const completionRate = numPages ? (durations[index].data.length / numPages) * 100 : 0;
+
+ return {
+ ...view,
+ duration: durations[index],
+ totalDuration: summedDurations[index],
+ completionRate: completionRate.toFixed(),
+ }
+ });
+
+ // TODO: Check that the user is owner of the links, otherwise return 401
+
+ // console.log("viewsWithDuration:", viewsWithDuration)
+
+ res.status(200).json(viewsWithDuration);
+ } catch (error) {
+ log(`Failed to get views for link ${id}. Error: \n\n ${error}`);
+ return res.status(500).json({
+ message: "Internal Server Error",
+ error: (error as Error).message,
+ });
+ }
+ } else {
+ // We only allow GET requests
+ res.setHeader("Allow", ["GET"]);
+ return res.status(405).end(`Method ${req.method} Not Allowed`);
+ }
+}