Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

Add support for async events export (#3354)

Steven Teya522d06d5cd7
diff --git a/apps/web/app/(ee)/api/commissions/export/route.ts b/apps/web/app/(ee)/api/commissions/export/route.ts
index 078e8ec39f..f899530520 100644
--- a/apps/web/app/(ee)/api/commissions/export/route.ts
+++ b/apps/web/app/(ee)/api/commissions/export/route.ts
@@ -11,7 +11,7 @@ import { NextResponse } from "next/server";
const MAX_COMMISSIONS_TO_EXPORT = 1000;
-// GET /api/commissions/export – export commissions to CSV
+// GET /api/commissions/export – export commissions to CSV (with async support if >1000 commissions)
export const GET = withWorkspace(
async ({ searchParams, workspace, session }) => {
const programId = getDefaultProgramIdOrThrow(workspace);
@@ -28,7 +28,7 @@ export const GET = withWorkspace(
// Process the export in the background if the number of commissions is greater than MAX_COMMISSIONS_TO_EXPORT
if (counts.all.count > MAX_COMMISSIONS_TO_EXPORT) {
await qstash.publishJSON({
- url: `${APP_DOMAIN_WITH_NGROK}/api/cron/commissions/export`,
+ url: `${APP_DOMAIN_WITH_NGROK}/api/cron/export/commissions`,
body: {
...parsedParams,
columns: columns.join(","),
diff --git a/apps/web/app/(ee)/api/cron/commissions/export/fetch-commissions-batch.ts b/apps/web/app/(ee)/api/cron/export/commissions/fetch-commissions-batch.ts
similarity index 100%
rename from apps/web/app/(ee)/api/cron/commissions/export/fetch-commissions-batch.ts
rename to apps/web/app/(ee)/api/cron/export/commissions/fetch-commissions-batch.ts
diff --git a/apps/web/app/(ee)/api/cron/commissions/export/route.ts b/apps/web/app/(ee)/api/cron/export/commissions/route.ts
similarity index 96%
rename from apps/web/app/(ee)/api/cron/commissions/export/route.ts
rename to apps/web/app/(ee)/api/cron/export/commissions/route.ts
index 46e2ddc071..a2a30da171 100644
--- a/apps/web/app/(ee)/api/cron/commissions/export/route.ts
+++ b/apps/web/app/(ee)/api/cron/export/commissions/route.ts
@@ -19,7 +19,7 @@ const payloadSchema = commissionsExportQuerySchema.extend({
userId: z.string(),
});
-// POST /api/cron/commissions/export - QStash worker for processing large commission exports
+// POST /api/cron/export/commissions - QStash worker for processing large commission exports
export async function POST(req: Request) {
try {
const rawBody = await req.text();
@@ -89,7 +89,7 @@ export async function POST(req: Request) {
await sendEmail({
to: user.email,
- subject: "Your commission export is ready",
+ subject: "Your commissions export is ready",
react: ExportReady({
email: user.email,
exportType: "commissions",
diff --git a/apps/web/app/(ee)/api/cron/export/events/fetch-events-batch.ts b/apps/web/app/(ee)/api/cron/export/events/fetch-events-batch.ts
new file mode 100644
index 0000000000..039a978fac
--- /dev/null
+++ b/apps/web/app/(ee)/api/cron/export/events/fetch-events-batch.ts
@@ -0,0 +1,26 @@
+import { getEvents } from "@/lib/analytics/get-events";
+import { EventsFilters } from "@/lib/analytics/types";
+
+export async function* fetchEventsBatch(
+ filters: Omit<EventsFilters, "page" | "limit">,
+ pageSize: number = 1000,
+) {
+ let page = 1;
+ let hasMore = true;
+
+ while (hasMore) {
+ const events = await getEvents({
+ ...filters,
+ page,
+ limit: pageSize,
+ });
+
+ if (events.length > 0) {
+ yield { events };
+ page++;
+ hasMore = events.length === pageSize;
+ } else {
+ hasMore = false;
+ }
+ }
+}
diff --git a/apps/web/app/(ee)/api/cron/export/events/partner/route.ts b/apps/web/app/(ee)/api/cron/export/events/partner/route.ts
new file mode 100644
index 0000000000..ec5ad30c7f
--- /dev/null
+++ b/apps/web/app/(ee)/api/cron/export/events/partner/route.ts
@@ -0,0 +1,192 @@
+import {
+ eventsExportColumnAccessors,
+ eventsExportColumnNames,
+} from "@/lib/analytics/events-export-helpers";
+import { convertToCSV } from "@/lib/analytics/utils/convert-to-csv";
+import { createDownloadableExport } from "@/lib/api/create-downloadable-export";
+import { handleAndReturnErrorResponse } from "@/lib/api/errors";
+import { getProgramEnrollmentOrThrow } from "@/lib/api/programs/get-program-enrollment-or-throw";
+import { generateExportFilename } from "@/lib/api/utils/generate-export-filename";
+import { generateRandomString } from "@/lib/api/utils/generate-random-string";
+import { MAX_PARTNER_LINKS_FOR_LOCAL_FILTERING } from "@/lib/constants/partner-profile";
+import { verifyQstashSignature } from "@/lib/cron/verify-qstash";
+import { generateRandomName } from "@/lib/names";
+import {
+ partnerProfileEventsQuerySchema,
+ PartnerProfileLinkSchema,
+} from "@/lib/zod/schemas/partner-profile";
+import { sendEmail } from "@dub/email";
+import ExportReady from "@dub/email/templates/export-ready";
+import { prisma } from "@dub/prisma";
+import { capitalize, log } from "@dub/utils";
+import * as z from "zod/v4";
+import { logAndRespond } from "../../../utils";
+import { fetchEventsBatch } from "../fetch-events-batch";
+
+const payloadSchema = partnerProfileEventsQuerySchema.extend({
+ columns: z
+ .string()
+ .transform((c) => c.split(","))
+ .pipe(z.string().array()),
+ partnerId: z.string(),
+ programId: z.string(),
+ userId: z.string(),
+ linkId: z.string().optional(),
+ domain: z.string().optional(),
+ key: z.string().optional(),
+ dataAvailableFrom: z.string().optional(),
+});
+
+// POST /api/cron/export/events/partner - QStash worker for processing large partner event exports
+export async function POST(req: Request) {
+ try {
+ const rawBody = await req.text();
+
+ await verifyQstashSignature({
+ req,
+ rawBody,
+ });
+
+ const { columns, partnerId, programId, userId, ...filters } =
+ payloadSchema.parse(JSON.parse(rawBody));
+
+ const user = await prisma.user.findUnique({
+ where: {
+ id: userId,
+ },
+ select: {
+ email: true,
+ },
+ });
+
+ if (!user) {
+ return logAndRespond(`User ${userId} not found. Skipping the export.`);
+ }
+
+ if (!user.email) {
+ return logAndRespond(`User ${userId} has no email. Skipping the export.`);
+ }
+
+ const { program, links, customerDataSharingEnabledAt } =
+ await getProgramEnrollmentOrThrow({
+ partnerId,
+ programId,
+ include: {
+ program: true,
+ links: true,
+ },
+ });
+
+ const { linkId, domain, key, dataAvailableFrom, ...eventFilters } = filters;
+
+ // If no links, return early with empty export
+ if (links.length === 0) {
+ return logAndRespond("No links found. Skipping the export.");
+ }
+
+ // Resolve linkId if domain and key are provided
+ let resolvedLinkId = linkId;
+ if (!resolvedLinkId && domain && key) {
+ const foundLink = links.find(
+ (link) => link.domain === domain && link.key === key,
+ );
+ if (foundLink) {
+ resolvedLinkId = foundLink.id;
+ }
+ }
+
+ // Fetch events in batches and build CSV
+ const allEvents: Record<string, any>[] = [];
+
+ const eventsFilters = {
+ ...eventFilters,
+ workspaceId: program.workspaceId,
+ ...(resolvedLinkId
+ ? { linkId: resolvedLinkId }
+ : links.length > MAX_PARTNER_LINKS_FOR_LOCAL_FILTERING
+ ? { partnerId }
+ : { linkIds: links.map((link) => link.id) }),
+ dataAvailableFrom: dataAvailableFrom
+ ? new Date(dataAvailableFrom)
+ : program.startedAt ?? program.createdAt,
+ };
+
+ for await (const { events } of fetchEventsBatch(eventsFilters)) {
+ // Apply partner profile data transformations
+ const transformedEvents = events.map((event) => {
+ // don't return ip address for partner profile
+ // @ts-ignore – ip is deprecated but present in the data
+ const { ip, click, customer, ...eventRest } = event;
+ const { ip: _, ...clickRest } = click;
+
+ return {
+ ...eventRest,
+ click: clickRest,
+ link: event?.link ? PartnerProfileLinkSchema.parse(event.link) : null,
+ ...(customer && {
+ customer: z
+ .object({
+ id: z.string(),
+ email: z.string(),
+ ...(customerDataSharingEnabledAt && { name: z.string() }),
+ })
+ .parse({
+ ...customer,
+ email: customer.email
+ ? customerDataSharingEnabledAt
+ ? customer.email
+ : customer.email.replace(/(?<=^.).+(?=.@)/, "****")
+ : customer.name || generateRandomName(),
+ ...(customerDataSharingEnabledAt && {
+ name: customer.name || generateRandomName(),
+ }),
+ }),
+ }),
+ };
+ });
+
+ const formattedEvents = transformedEvents.map((row) =>
+ Object.fromEntries(
+ columns.map((c) => [
+ eventsExportColumnNames?.[c] ?? capitalize(c),
+ eventsExportColumnAccessors[c]?.(row) ?? row?.[c],
+ ]),
+ ),
+ );
+ allEvents.push(...formattedEvents);
+ }
+
+ const csvData = convertToCSV(allEvents);
+
+ const { downloadUrl } = await createDownloadableExport({
+ fileKey: `exports/events/partner/${generateRandomString(16)}.csv`,
+ fileName: generateExportFilename("events"),
+ body: csvData,
+ contentType: "text/csv",
+ });
+
+ await sendEmail({
+ to: user.email,
+ subject: "Your events export is ready",
+ react: ExportReady({
+ email: user.email,
+ exportType: "events",
+ downloadUrl,
+ program: {
+ name: program.name,
+ },
+ }),
+ });
+
+ return logAndRespond(
+ `Export (${allEvents.length} events) generated and email sent to user.`,
+ );
+ } catch (error) {
+ await log({
+ message: `Error exporting partner events: ${error.message}`,
+ type: "cron",
+ });
+
+ return handleAndReturnErrorResponse(error);
+ }
+}
diff --git a/apps/web/app/(ee)/api/cron/export/events/workspace/route.ts b/apps/web/app/(ee)/api/cron/export/events/workspace/route.ts
new file mode 100644
index 0000000000..821c00f8e2
--- /dev/null
+++ b/apps/web/app/(ee)/api/cron/export/events/workspace/route.ts
@@ -0,0 +1,143 @@
+import {
+ eventsExportColumnAccessors,
+ eventsExportColumnNames,
+} from "@/lib/analytics/events-export-helpers";
+import { convertToCSV } from "@/lib/analytics/utils/convert-to-csv";
+import { createDownloadableExport } from "@/lib/api/create-downloadable-export";
+import { handleAndReturnErrorResponse } from "@/lib/api/errors";
+import { generateExportFilename } from "@/lib/api/utils/generate-export-filename";
+import { generateRandomString } from "@/lib/api/utils/generate-random-string";
+import { verifyQstashSignature } from "@/lib/cron/verify-qstash";
+import { eventsQuerySchema } from "@/lib/zod/schemas/analytics";
+import { sendEmail } from "@dub/email";
+import ExportReady from "@dub/email/templates/export-ready";
+import { prisma } from "@dub/prisma";
+import { capitalize, log } from "@dub/utils";
+import * as z from "zod/v4";
+import { logAndRespond } from "../../../utils";
+import { fetchEventsBatch } from "../fetch-events-batch";
+
+const payloadSchema = eventsQuerySchema.extend({
+ columns: z
+ .string()
+ .transform((c) => c.split(","))
+ .pipe(z.string().array()),
+ workspaceId: z.string(),
+ userId: z.string(),
+ linkId: z.string().optional(),
+ folderIds: z.array(z.string()).optional(),
+ folderId: z.string().optional(),
+ dataAvailableFrom: z.string().optional(),
+});
+
+// POST /api/cron/export/events/workspace - QStash worker for processing large event exports
+export async function POST(req: Request) {
+ try {
+ const rawBody = await req.text();
+
+ await verifyQstashSignature({
+ req,
+ rawBody,
+ });
+
+ const { columns, workspaceId, userId, ...filters } = payloadSchema.parse(
+ JSON.parse(rawBody),
+ );
+
+ const user = await prisma.user.findUnique({
+ where: {
+ id: userId,
+ },
+ select: {
+ email: true,
+ },
+ });
+
+ if (!user) {
+ return logAndRespond(`User ${userId} not found. Skipping the export.`);
+ }
+
+ if (!user.email) {
+ return logAndRespond(`User ${userId} has no email. Skipping the export.`);
+ }
+
+ const workspace = await prisma.project.findUnique({
+ where: {
+ id: workspaceId,
+ },
+ select: {
+ id: true,
+ name: true,
+ createdAt: true,
+ },
+ });
+
+ if (!workspace) {
+ return logAndRespond(
+ `Workspace ${workspaceId} not found. Skipping the export.`,
+ );
+ }
+
+ const { linkId, folderIds, folderId, dataAvailableFrom, ...eventFilters } =
+ filters;
+
+ // Fetch events in batches and build CSV
+ const allEvents: Record<string, any>[] = [];
+
+ const eventsFilters = {
+ ...eventFilters,
+ ...(linkId && { linkId }),
+ workspaceId,
+ folderIds,
+ folderId: folderId || "",
+ dataAvailableFrom: dataAvailableFrom
+ ? new Date(dataAvailableFrom)
+ : workspace.createdAt,
+ };
+
+ for await (const { events } of fetchEventsBatch(eventsFilters)) {
+ const formattedEvents = events.map((row) =>
+ Object.fromEntries(
+ columns.map((c) => [
+ eventsExportColumnNames?.[c] ?? capitalize(c),
+ eventsExportColumnAccessors[c]?.(row) ?? row?.[c],
+ ]),
+ ),
+ );
+ allEvents.push(...formattedEvents);
+ }
+
+ const csvData = convertToCSV(allEvents);
+
+ const { downloadUrl } = await createDownloadableExport({
+ fileKey: `exports/events/workspace/${generateRandomString(16)}.csv`,
+ fileName: generateExportFilename("events"),
+ body: csvData,
+ contentType: "text/csv",
+ });
+
+ await sendEmail({
+ to: user.email,
+ subject: "Your events export is ready",
+ react: ExportReady({
+ email: user.email,
+ exportType: "events",
+ downloadUrl,
+ workspace: {
+ name: workspace.name,
+ },
+ }),
+ });
+
+ return logAndRespond(
+ `Export (${allEvents.length} events) generated and email sent to user.`,
+ );
+ } catch (error) {
+ await log({
+ message: `Error exporting events: ${error.message}`,
+ type: "cron",
+ });
+
+ return handleAndReturnErrorResponse(error);
+ }
+}
diff --git a/apps/web/app/(ee)/api/cron/links/export/fetch-links-batch.ts b/apps/web/app/(ee)/api/cron/export/links/fetch-links-batch.ts
similarity index 100%
rename from apps/web/app/(ee)/api/cron/links/export/fetch-links-batch.ts
rename to apps/web/app/(ee)/api/cron/export/links/fetch-links-batch.ts
diff --git a/apps/web/app/(ee)/api/cron/links/export/route.ts b/apps/web/app/(ee)/api/cron/export/links/route.ts
similarity index 97%
rename from apps/web/app/(ee)/api/cron/links/export/route.ts
rename to apps/web/app/(ee)/api/cron/export/links/route.ts
index 089c48f541..bd4d185066 100644
--- a/apps/web/app/(ee)/api/cron/links/export/route.ts
+++ b/apps/web/app/(ee)/api/cron/export/links/route.ts
@@ -24,7 +24,7 @@ const payloadSchema = linksExportQuerySchema.extend({
userId: z.string(),
});
-// POST /api/cron/links/export - QStash worker for processing large link exports
+// POST /api/cron/export/links - QStash worker for processing large link exports
export async function POST(req: Request) {
try {
const rawBody = await req.text();
@@ -131,7 +131,7 @@ export async function POST(req: Request) {
await sendEmail({
to: user.email,
- subject: "Your link export is ready",
+ subject: "Your links export is ready",
react: ExportReady({
email: user.email,
exportType: "links",
diff --git a/apps/web/app/(ee)/api/cron/partners/export/fetch-partners-batch.ts b/apps/web/app/(ee)/api/cron/export/partners/fetch-partners-batch.ts
similarity index 100%
rename from apps/web/app/(ee)/api/cron/partners/export/fetch-partners-batch.ts
rename to apps/web/app/(ee)/api/cron/export/partners/fetch-partners-batch.ts
diff --git a/apps/web/app/(ee)/api/cron/partners/export/route.ts b/apps/web/app/(ee)/api/cron/export/partners/route.ts
similarity index 96%
rename from apps/web/app/(ee)/api/cron/partners/export/route.ts
rename to apps/web/app/(ee)/api/cron/export/partners/route.ts
index 8319d83f28..7774dba716 100644
--- a/apps/web/app/(ee)/api/cron/partners/export/route.ts
+++ b/apps/web/app/(ee)/api/cron/export/partners/route.ts
@@ -19,7 +19,7 @@ const payloadSchema = partnersExportQuerySchema.extend({
userId: z.string(),
});
-// POST /api/cron/partners/export - QStash worker for processing large partner exports
+// POST /api/cron/export/partners - QStash worker for processing large partner exports
export async function POST(req: Request) {
try {
const rawBody = await req.text();
@@ -87,7 +87,7 @@ export async function POST(req: Request) {
await sendEmail({
to: user.email,
- subject: "Your partner export is ready",
+ subject: "Your partners export is ready",
react: ExportReady({
email: user.email,
exportType: "partners",
diff --git a/apps/web/app/(ee)/api/events/export/route.ts b/apps/web/app/(ee)/api/events/export/route.ts
index 8d5e25346d..2296f1a66d 100644
--- a/apps/web/app/(ee)/api/events/export/route.ts
+++ b/apps/web/app/(ee)/api/events/export/route.ts
@@ -1,3 +1,8 @@
+import {
+ eventsExportColumnAccessors,
+ eventsExportColumnNames,
+} from "@/lib/analytics/events-export-helpers";
+import { getAnalytics } from "@/lib/analytics/get-analytics";
import { getEvents } from "@/lib/analytics/get-events";
import { getFolderIdsToFilter } from "@/lib/analytics/get-folder-ids-to-filter";
import { convertToCSV } from "@/lib/analytics/utils";
@@ -6,43 +11,16 @@ import { getLinkOrThrow } from "@/lib/api/links/get-link-or-throw";
import { throwIfClicksUsageExceeded } from "@/lib/api/links/usage-checks";
import { assertValidDateRangeForPlan } from "@/lib/api/utils/assert-valid-date-range-for-plan";
import { withWorkspace } from "@/lib/auth";
+import { qstash } from "@/lib/cron";
import { verifyFolderAccess } from "@/lib/folder/permissions";
-import { ClickEvent, LeadEvent, SaleEvent } from "@/lib/types";
import { eventsQuerySchema } from "@/lib/zod/schemas/analytics";
-import { COUNTRIES, capitalize } from "@dub/utils";
+import { APP_DOMAIN_WITH_NGROK, capitalize } from "@dub/utils";
+import { NextResponse } from "next/server";
import * as z from "zod/v4";
-type Row = ClickEvent | LeadEvent | SaleEvent;
-
-const columnNames: Record<string, string> = {
- trigger: "Event",
- url: "Destination URL",
- os: "OS",
- referer: "Referrer",
- refererUrl: "Referrer URL",
- timestamp: "Date",
- invoiceId: "Invoice ID",
- saleAmount: "Sale Amount",
- clickId: "Click ID",
-};
-
-const columnAccessors = {
- trigger: (r: Row) => r.click.trigger,
- event: (r: LeadEvent | SaleEvent) => r.eventName,
- url: (r: ClickEvent) => r.click.url,
- link: (r: Row) => r.domain + (r.key === "_root" ? "" : `/${r.key}`),
- country: (r: Row) =>
- r.country ? COUNTRIES[r.country] ?? r.country : r.country,
- referer: (r: ClickEvent) => r.click.referer,
- refererUrl: (r: ClickEvent) => r.click.refererUrl,
- customer: (r: LeadEvent | SaleEvent) =>
- r.customer.name + (r.customer.email ? ` <${r.customer.email}>` : ""),
- invoiceId: (r: SaleEvent) => r.sale.invoiceId,
- saleAmount: (r: SaleEvent) => "$" + (r.sale.amount / 100).toFixed(2),
- clickId: (r: ClickEvent) => r.click.id,
-};
-
-// GET /api/events/export – get export data for analytics
+const MAX_EVENTS_TO_EXPORT = 1000;
+
+// GET /api/events/export – export events to CSV (with async support if >1000 events)
export const GET = withWorkspace(
async ({ searchParams, workspace, session }) => {
throwIfClicksUsageExceeded(workspace);
@@ -93,11 +71,48 @@ export const GET = withWorkspace(
userId: session.user.id,
});
+ // Count events using getAnalytics with groupBy: "count"
+ const countResponse = await getAnalytics({
+ ...parsedParams,
+ groupBy: "count",
+ ...(link && { linkId: link.id }),
+ folderIds,
+ workspaceId: workspace.id,
+ dataAvailableFrom: workspace.createdAt,
+ });
+
+ // Extract the count based on event type
+ // getAnalytics with groupBy: "count" returns an object like { clicks: 123 } or { leads: 45 } or { sales: 10, saleAmount: 5000 }
+ const eventsCount =
+ typeof countResponse === "object" && countResponse !== null
+ ? (countResponse[event as keyof typeof countResponse] as number) ?? 0
+ : typeof countResponse === "number"
+ ? countResponse
+ : 0;
+
+ // Process the export in the background if the number of events is greater than MAX_EVENTS_TO_EXPORT
+ if (eventsCount > MAX_EVENTS_TO_EXPORT) {
+ await qstash.publishJSON({
+ url: `${APP_DOMAIN_WITH_NGROK}/api/cron/export/events/workspace`,
+ body: {
+ ...searchParams,
+ workspaceId: workspace.id,
+ userId: session.user.id,
+ ...(link && { linkId: link.id }),
+ folderIds: folderIds ? folderIds : undefined,
+ folderId: folderId || "",
+ dataAvailableFrom: workspace.createdAt.toISOString(),
+ },
+ });
+
+ return NextResponse.json({}, { status: 202 });
+ }
+
const response = await getEvents({
...parsedParams,
...(link && { linkId: link.id }),
workspaceId: workspace.id,
- limit: 100000,
+ limit: MAX_EVENTS_TO_EXPORT,
folderIds,
folderId: folderId || "",
});
@@ -105,8 +120,8 @@ export const GET = withWorkspace(
const data = response.map((row) =>
Object.fromEntries(
columns.map((c) => [
- columnNames?.[c] ?? capitalize(c),
- columnAccessors[c]?.(row) ?? row?.[c],
+ eventsExportColumnNames?.[c] ?? capitalize(c),
+ eventsExportColumnAccessors[c]?.(row) ?? row?.[c],
]),
),
);
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/export/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/export/route.ts
index 83e16e0ea9..dd8ac6cfab 100644
--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/export/route.ts
+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/events/export/route.ts
@@ -1,3 +1,8 @@
+import {
+ eventsExportColumnAccessors,
+ eventsExportColumnNames,
+} from "@/lib/analytics/events-export-helpers";
+import { getAnalytics } from "@/lib/analytics/get-analytics";
import { getEvents } from "@/lib/analytics/get-events";
import { convertToCSV } from "@/lib/analytics/utils";
import { DubApiError } from "@/lib/api/errors";
@@ -8,48 +13,21 @@ import {
LARGE_PROGRAM_MIN_TOTAL_COMMISSIONS_CENTS,
MAX_PARTNER_LINKS_FOR_LOCAL_FILTERING,
} from "@/lib/constants/partner-profile";
+import { qstash } from "@/lib/cron";
import { generateRandomName } from "@/lib/names";
-import { ClickEvent, LeadEvent, SaleEvent } from "@/lib/types";
import {
PartnerProfileLinkSchema,
partnerProfileEventsQuerySchema,
} from "@/lib/zod/schemas/partner-profile";
-import { COUNTRIES, capitalize } from "@dub/utils";
+import { APP_DOMAIN_WITH_NGROK, capitalize } from "@dub/utils";
+import { NextResponse } from "next/server";
import * as z from "zod/v4";
-type Row = ClickEvent | LeadEvent | SaleEvent;
-
-const columnNames: Record<string, string> = {
- trigger: "Event",
- url: "Destination URL",
- os: "OS",
- referer: "Referrer",
- refererUrl: "Referrer URL",
- timestamp: "Date",
- invoiceId: "Invoice ID",
- saleAmount: "Sale Amount",
- clickId: "Click ID",
-};
-
-const columnAccessors = {
- trigger: (r: Row) => r.click.trigger,
- event: (r: LeadEvent | SaleEvent) => r.eventName,
- url: (r: ClickEvent) => r.click.url,
- link: (r: Row) => r.domain + (r.key === "_root" ? "" : `/${r.key}`),
- country: (r: Row) =>
- r.country ? COUNTRIES[r.country] ?? r.country : r.country,
- referer: (r: ClickEvent) => r.click.referer,
- refererUrl: (r: ClickEvent) => r.click.refererUrl,
- customer: (r: LeadEvent | SaleEvent) =>
- r.customer.name + (r.customer.email ? ` <${r.customer.email}>` : ""),
- invoiceId: (r: SaleEvent) => r.sale.invoiceId,
- saleAmount: (r: SaleEvent) => "$" + (r.sale.amount / 100).toFixed(2),
- clickId: (r: ClickEvent) => r.click.id,
-};
+const MAX_EVENTS_TO_EXPORT = 1000;
// GET /api/partner-profile/programs/[programId]/events/export – get export data for partner profile events
export const GET = withPartnerProfile(
- async ({ partner, params, searchParams }) => {
+ async ({ partner, params, searchParams, session }) => {
const { program, links, totalCommissions, customerDataSharingEnabledAt } =
await getProgramEnrollmentOrThrow({
partnerId: partner.id,
@@ -132,6 +110,51 @@ export const GET = withPartnerProfile(
});
}
+ // Count events using getAnalytics with groupBy: "count"
+ const countResponse = await getAnalytics({
+ ...rest,
+ event,
+ groupBy: "count",
+ workspaceId: program.workspaceId,
+ ...(linkId
+ ? { linkId }
+ : links.length > MAX_PARTNER_LINKS_FOR_LOCAL_FILTERING
+ ? { partnerId: partner.id }
+ : { linkIds: links.map((link) => link.id) }),
+ dataAvailableFrom: program.startedAt ?? program.createdAt,
+ });
+
+ // Extract the count based on event type
+ // getAnalytics with groupBy: "count" returns an object like { clicks: 123 } or { leads: 45 } or { sales: 10, saleAmount: 5000 }
+ const eventsCount =
+ typeof countResponse === "object" && countResponse !== null
+ ? (countResponse[event as keyof typeof countResponse] as number) ?? 0
+ : typeof countResponse === "number"
+ ? countResponse
+ : 0;
+
+ // Process the export in the background if the number of events is greater than MAX_EVENTS_TO_EXPORT
+ if (eventsCount > MAX_EVENTS_TO_EXPORT) {
+ await qstash.publishJSON({
+ url: `${APP_DOMAIN_WITH_NGROK}/api/cron/export/events/partner`,
+ body: {
+ ...searchParams,
+ columns: columns.join(","),
+ partnerId: partner.id,
+ programId: params.programId,
+ userId: session.user.id,
+ ...(linkId && { linkId }),
+ ...(domain && { domain }),
+ ...(key && { key }),
+ dataAvailableFrom: (
+ program.startedAt ?? program.createdAt
+ ).toISOString(),
+ },
+ });
+
+ return NextResponse.json({}, { status: 202 });
+ }
+
const events = await getEvents({
...rest,
workspaceId: program.workspaceId,
@@ -141,7 +164,7 @@ export const GET = withPartnerProfile(
? { partnerId: partner.id }
: { linkIds: links.map((link) => link.id) }),
dataAvailableFrom: program.startedAt ?? program.createdAt,
- limit: 100000,
+ limit: MAX_EVENTS_TO_EXPORT,
});
// Apply partner profile data transformations similar to the main events route
@@ -180,8 +203,8 @@ export const GET = withPartnerProfile(
const data = transformedEvents.map((row) =>
Object.fromEntries(
columns.map((c) => [
- columnNames?.[c] ?? capitalize(c),
- columnAccessors[c]?.(row) ?? row?.[c],
+ eventsExportColumnNames?.[c] ?? capitalize(c),
+ eventsExportColumnAccessors[c]?.(row) ?? row?.[c],
]),
),
);
diff --git a/apps/web/app/(ee)/api/partners/export/route.ts b/apps/web/app/(ee)/api/partners/export/route.ts
index 6a64d6c840..f96f8b9e55 100644
--- a/apps/web/app/(ee)/api/partners/export/route.ts
+++ b/apps/web/app/(ee)/api/partners/export/route.ts
@@ -28,7 +28,7 @@ export const GET = withWorkspace(
// Process the export in the background if the number of partners is greater than MAX_PARTNERS_TO_EXPORT
if (partnersCount > MAX_PARTNERS_TO_EXPORT) {
await qstash.publishJSON({
- url: `${APP_DOMAIN_WITH_NGROK}/api/cron/partners/export`,
+ url: `${APP_DOMAIN_WITH_NGROK}/api/cron/export/partners`,
body: {
...parsedParams,
columns: columns.join(","),
diff --git a/apps/web/app/api/links/export/route.ts b/apps/web/app/api/links/export/route.ts
index d64a3b45e8..0c774f6893 100644
--- a/apps/web/app/api/links/export/route.ts
+++ b/apps/web/app/api/links/export/route.ts
@@ -45,7 +45,7 @@ export const GET = withWorkspace(
// Process the export in the background if the number of links is greater than MAX_LINKS_TO_EXPORT
if (linksCount > MAX_LINKS_TO_EXPORT) {
await qstash.publishJSON({
- url: `${APP_DOMAIN_WITH_NGROK}/api/cron/links/export`,
+ url: `${APP_DOMAIN_WITH_NGROK}/api/cron/export/links`,
body: {
...searchParams,
workspaceId: workspace.id,
diff --git a/apps/web/lib/analytics/events-export-helpers.ts b/apps/web/lib/analytics/events-export-helpers.ts
new file mode 100644
index 0000000000..e17812463e
--- /dev/null
+++ b/apps/web/lib/analytics/events-export-helpers.ts
@@ -0,0 +1,33 @@
+import { ClickEvent, LeadEvent, SaleEvent } from "@/lib/types";
+import { COUNTRIES } from "@dub/utils";
+
+export type Row = ClickEvent | LeadEvent | SaleEvent;
+
+export const eventsExportColumnNames: Record<string, string> = {
+ trigger: "Event",
+ url: "Destination URL",
+ os: "OS",
+ referer: "Referrer",
+ refererUrl: "Referrer URL",
+ timestamp: "Date",
+ invoiceId: "Invoice ID",
+ saleAmount: "Sale Amount",
+ clickId: "Click ID",
+};
+
+export const eventsExportColumnAccessors = {
+ trigger: (r: Row) => r.click.trigger,
+ event: (r: LeadEvent | SaleEvent) => r.eventName,
+ url: (r: ClickEvent) => r.click.url,
+ link: (r: Row) => r.domain + (r.key === "_root" ? "" : `/${r.key}`),
+ country: (r: Row) =>
+ r.country ? COUNTRIES[r.country] ?? r.country : r.country,
+ referer: (r: ClickEvent) => r.click.referer,
+ refererUrl: (r: ClickEvent) => r.click.refererUrl,
+ customer: (r: LeadEvent | SaleEvent) =>
+ r.customer.name + (r.customer.email ? ` <${r.customer.email}>` : ""),
+ invoiceId: (r: Row) => ("sale" in r ? r.sale.invoiceId : ""),
+ saleAmount: (r: Row) =>
+ "sale" in r ? "$" + (r.sale.amount / 100).toFixed(2) : "",
+ clickId: (r: ClickEvent) => r.click.id,
+};
diff --git a/apps/web/ui/analytics/events/events-export-button.tsx b/apps/web/ui/analytics/events/events-export-button.tsx
index 2fc2d5fef6..2be734d5a0 100644
--- a/apps/web/ui/analytics/events/events-export-button.tsx
+++ b/apps/web/ui/analytics/events/events-export-button.tsx
@@ -1,5 +1,6 @@
import useWorkspace from "@/lib/swr/use-workspace";
import { Button, Download, TooltipContent } from "@dub/ui";
+import { useSession } from "next-auth/react";
import { Dispatch, SetStateAction, useContext } from "react";
import { toast } from "sonner";
import { AnalyticsContext } from "../analytics-provider";
@@ -13,6 +14,7 @@ export function EventsExportButton({
const { exportQueryString } = useContext(EventsContext);
const { eventsApiPath } = useContext(AnalyticsContext);
const { slug, plan } = useWorkspace();
+ const { data: session } = useSession();
const needsHigherPlan = plan === "free" || plan === "pro";
@@ -31,12 +33,25 @@ export function EventsExportButton({
throw new Error(response.statusText);
}
+ if (response.status === 202) {
+ setOpenPopover(false);
+ return {
+ isAsync: true,
+ message: `Your export is being processed and we'll send you an email (${session?.user?.email}) when it's ready to download.`,
+ };
+ }
+
const blob = await response.blob();
const url = window.URL.createObjectURL(blob);
const a = document.createElement("a");
a.href = url;
a.download = `Dub Events Export - ${new Date().toISOString()}.csv`;
a.click();
+ setOpenPopover(false);
+ return {
+ isAsync: false,
+ message: "Exported successfully",
+ };
}
return (
@@ -57,10 +72,9 @@ export function EventsExportButton({
onClick={() => {
toast.promise(exportData(), {
loading: "Exporting file...",
- success: "Exported successfully",
+ success: (data) => data.message,
error: (error) => error,
});
- setOpenPopover(false);
}}
/>
);
diff --git a/packages/email/src/templates/export-ready.tsx b/packages/email/src/templates/export-ready.tsx
index 5eba87decf..3c5a67b7ab 100644
--- a/packages/email/src/templates/export-ready.tsx
+++ b/packages/email/src/templates/export-ready.tsx
@@ -24,7 +24,7 @@ export default function ExportReady({
}: {
email: string;
downloadUrl: string;
- exportType: "partners" | "commissions" | "links";
+ exportType: "partners" | "commissions" | "links" | "events";
expiresInDays?: number;
program?: {
name: string;
@@ -48,8 +48,9 @@ export default function ExportReady({
Your {exportType} export is ready
</Heading>
<Text className="text-sm leading-6 text-black">
- Your export of {exportType} from <strong>{contextName}</strong>{" "}
- has been completed and is ready to download.
+ Your {exportType} export from your <strong>{contextName}</strong>{" "}
+ {program ? "program" : "workspace"} has been completed and is
+ ready to download.
</Text>
<Section className="my-8">
<Link