The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
use composite event for analytics csv export
Pedro Ladeirac7b76f4f23a6
diff --git a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/export/route.ts b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/export/route.tsindex bf630ab8df..0b17bc3b00 100644--- a/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/export/route.ts+++ b/apps/web/app/(ee)/api/partner-profile/programs/[programId]/analytics/export/route.ts@@ -1,7 +1,8 @@-import { VALID_ANALYTICS_ENDPOINTS } from "@/lib/analytics/constants";+import {+ exportAnalyticsToZip,+ PARTNER_PROFILE_SKIP_ENDPOINTS,+} from "@/lib/analytics/export-analytics-to-zip";import { getFirstFilterValue } from "@/lib/analytics/filter-helpers";-import { getAnalytics } from "@/lib/analytics/get-analytics";-import { convertToCSV } from "@/lib/analytics/utils";import { DubApiError } from "@/lib/api/errors";import { getProgramEnrollmentOrThrow } from "@/lib/api/programs/get-program-enrollment-or-throw";import { withPartnerProfile } from "@/lib/auth/partner";@@ -10,9 +11,11 @@ import {LARGE_PROGRAM_MIN_TOTAL_COMMISSIONS_CENTS,MAX_PARTNER_LINKS_FOR_LOCAL_FILTERING,} from "@/lib/constants/partner-profile";+import { ratelimit } from "@/lib/upstash";import { partnerProfileAnalyticsQuerySchema } from "@/lib/zod/schemas/partner-profile";import { parseFilterValue, toCentsNumber } from "@dub/utils";-import JSZip from "jszip";++export const maxDuration = 300;// GET /api/partner-profile/programs/[programId]/analytics/export – get export data for partner profile analyticsexport const GET = withPartnerProfile(@@ -38,7 +41,6 @@ export const GET = withPartnerProfile(});}- // Early return if partner has no linksif (links.length === 0) {throw new DubApiError({code: "not_found",@@ -51,7 +53,6 @@ export const GET = withPartnerProfile(const { linkId, domain, key } = parsedParams;if (linkId) {- // check to make sure all of the linkId.values are in the linksif (!linkId.values.every((value) => links.some((link) => link.id === value))) {@@ -62,12 +63,10 @@ export const GET = withPartnerProfile(}if (linkId.sqlOperator === "NOT IN") {- // if using NOT IN operator, we need to include all links except the ones in the linkId.valuesconst finalIncludedLinkIds = links.filter((link) => !linkId.values.includes(link.id)).map((link) => link.id);- // early return if no links are leftif (finalIncludedLinkIds.length === 0) {throw new DubApiError({code: "not_found",@@ -100,47 +99,35 @@ export const GET = withPartnerProfile(};}- const zip = new JSZip();-- await Promise.all(- VALID_ANALYTICS_ENDPOINTS.map(async (endpoint) => {- // no need to fetch top links data if there's a link specified- // since this is just a single link- if (endpoint === "top_links" && linkId) return;- // skip other irrelevant endpoints for partner profile analytics export- if (- [- "count",- "top_partners",- "top_groups",- "top_partner_tags",- "top_folders",- "top_link_tags",- ].includes(endpoint)- ) {- return;- }-- const response = await getAnalytics({- ...parsedParams,- workspaceId: program.workspaceId,- ...(parsedParams.linkId- ? { linkId: parsedParams.linkId }- : links.length > MAX_PARTNER_LINKS_FOR_LOCAL_FILTERING- ? { partnerId: partner.id }- : { linkId: parseFilterValue(links.map((link) => link.id)) }),- dataAvailableFrom: program.startedAt ?? program.createdAt,- groupBy: endpoint,- });-- if (!response || response.length === 0) return;-- const csvData = convertToCSV(response);- zip.file(`${endpoint}.csv`, csvData);- }),+ const { success } = await ratelimit(1, "30 s").limit(+ `analytics-export:partner:${partner.id}:${params.programId}`,);- const zipData = await zip.generateAsync({ type: "nodebuffer" });+ if (!success) {+ throw new DubApiError({+ code: "rate_limit_exceeded",+ message:+ "Analytics export is limited to once every 30 seconds. Please try again shortly.",+ });+ }++ const dataAvailableFrom = program.startedAt ?? program.createdAt;+ const hasSingleLinkFilter = Boolean(parsedParams.linkId);++ const zipData = await exportAnalyticsToZip({+ params: parsedParams,+ workspaceId: program.workspaceId,+ useComposite: true,+ skipEndpoints: PARTNER_PROFILE_SKIP_ENDPOINTS,+ skipTopLinksForSingleLink: hasSingleLinkFilter,+ getAnalyticsParams: () =>+ parsedParams.linkId+ ? { linkId: parsedParams.linkId }+ : links.length > MAX_PARTNER_LINKS_FOR_LOCAL_FILTERING+ ? { partnerId: partner.id }+ : { linkId: parseFilterValue(links.map((link) => link.id)) },+ getDataAvailableFrom: () => dataAvailableFrom,+ });return new Response(zipData as unknown as BodyInit, {headers: {diff --git a/apps/web/app/api/analytics/export/route.ts b/apps/web/app/api/analytics/export/route.tsindex 0a2e487509..6771956ec6 100644--- a/apps/web/app/api/analytics/export/route.ts+++ b/apps/web/app/api/analytics/export/route.ts@@ -1,7 +1,5 @@-import { VALID_ANALYTICS_ENDPOINTS } from "@/lib/analytics/constants";+import { exportAnalyticsToZip } from "@/lib/analytics/export-analytics-to-zip";import { getFirstFilterValue } from "@/lib/analytics/filter-helpers";-import { getAnalytics } from "@/lib/analytics/get-analytics";-import { convertToCSV } from "@/lib/analytics/utils";import { formatProgramAnalyticsForExport } from "@/lib/analytics/utils/format-program-analytics-for-export";import { DubApiError } from "@/lib/api/errors";import { getLinkOrThrow } from "@/lib/api/links/get-link-or-throw";@@ -12,11 +10,13 @@ import { assertValidDateRangeForPlan } from "@/lib/api/utils/assert-valid-date-rimport { prefixWorkspaceId } from "@/lib/api/workspaces/workspace-id";import { withWorkspace } from "@/lib/auth";import { verifyFolderAccess } from "@/lib/folder/permissions";+import { getPlanCapabilities } from "@/lib/plan-capabilities";+import { ratelimit } from "@/lib/upstash";import { parseAnalyticsQuery } from "@/lib/zod/schemas/analytics";-import { Link } from "@dub/prisma/client";-import JSZip from "jszip";-// GET /api/analytics/export – get export data for analytics+export const maxDuration = 300;++// GET /api/analytics/export – get export data for analyticsexport const GET = withWorkspace(async ({ searchParams, workspace, session }) => {throwIfClicksUsageExceeded(workspace);@@ -35,8 +35,6 @@ export const GET = withWorkspace(programId,} = parsedParams;- let link: Link | null = null;-let programStartedAt: Date | null | undefined = null;if (programId) {const workspaceProgramId = getDefaultProgramIdOrThrow(workspace);@@ -46,7 +44,6 @@ export const GET = withWorkspace(message: `Program ${programId} does not belong to workspace ${prefixWorkspaceId(workspace.id)}.`,});}- // dataAvailableFrom for timeseries is resolved per-endpoint belowconst program = await getProgramOrThrow({workspaceId: workspace.id,programId,@@ -70,7 +67,6 @@ export const GET = withWorkspace(values: [link.id],};- // since we're filtering for a specific link, exclude domain from filtersparsedParams.domain = undefined;if (link.folderId && !folderIdToVerify) {@@ -95,39 +91,41 @@ export const GET = withWorkspace(end,});- // When domain+key resolves a specific link, exclude domain from filters- const { domain: _domain, key: _key, ...filterParams } = parsedParams;+ const useComposite = getPlanCapabilities(+ workspace.plan,+ ).canTrackConversions;- const zip = new JSZip();-- await Promise.all(- VALID_ANALYTICS_ENDPOINTS.map(async (endpoint) => {- // no need to fetch top links data if there's a link specified- // since this is just a single link- if (endpoint === "top_links" && link) return;- // skip clicks count- if (endpoint === "count") return;-- const response = await getAnalytics({- ...(link ? filterParams : parsedParams),- workspaceId: workspace.id,- groupBy: endpoint,- isDeprecatedClicksEndpoint: false,- ...(endpoint === "timeseries" && {- dataAvailableFrom: programStartedAt ?? workspace.createdAt,- }),- });+ if (useComposite) {+ const { success } = await ratelimit(1, "30 s").limit(+ `analytics-export:${workspace.id}`,+ );- if (!response || response.length === 0) return;+ if (!success) {+ throw new DubApiError({+ code: "rate_limit_exceeded",+ message:+ "Analytics export is limited to once every 30 seconds. Please try again shortly.",+ });+ }+ }- const csvData = convertToCSV(- programId ? formatProgramAnalyticsForExport(response) : response,- );- zip.file(`${endpoint}.csv`, csvData);+ const { domain: _domain, key: _key, ...filterParams } = parsedParams;+ const hasSingleLinkFilter = Boolean(parsedParams.linkId);+ const analyticsParams = hasSingleLinkFilter ? filterParams : parsedParams;++ const zipData = await exportAnalyticsToZip({+ params: analyticsParams,+ workspaceId: workspace.id,+ useComposite,+ skipTopLinksForSingleLink: hasSingleLinkFilter,+ getDataAvailableFrom: (endpoint) =>+ endpoint === "timeseries"+ ? programStartedAt ?? workspace.createdAt+ : undefined,+ ...(programId && {+ formatRows: formatProgramAnalyticsForExport,}),- );-- const zipData = await zip.generateAsync({ type: "nodebuffer" });+ });return new Response(zipData as unknown as BodyInit, {headers: {diff --git a/apps/web/lib/analytics/export-analytics-to-zip.ts b/apps/web/lib/analytics/export-analytics-to-zip.tsnew file mode 100644index 0000000000..619130bdb4--- /dev/null+++ b/apps/web/lib/analytics/export-analytics-to-zip.ts@@ -0,0 +1,95 @@+import { VALID_ANALYTICS_ENDPOINTS } from "@/lib/analytics/constants";+import { getAnalytics } from "@/lib/analytics/get-analytics";+import {+ AnalyticsFilters,+ AnalyticsGroupByOptions,+} from "@/lib/analytics/types";+import { convertToCSV } from "@/lib/analytics/utils/convert-to-csv";+import JSZip from "jszip";++const DEFAULT_SKIP_ENDPOINTS = ["count"] as const;++const PARTNER_PROFILE_SKIP_ENDPOINTS = [+ "count",+ "top_partners",+ "top_groups",+ "top_partner_tags",+ "top_folders",+ "top_link_tags",+] as const;++export type ExportAnalyticsToZipOptions = {+ params: AnalyticsFilters;+ workspaceId: string;+ useComposite: boolean;+ skipTopLinksForSingleLink?: boolean;+ skipEndpoints?: readonly AnalyticsGroupByOptions[];+ getAnalyticsParams?: (+ endpoint: AnalyticsGroupByOptions,+ ) => Partial<AnalyticsFilters>;+ getDataAvailableFrom?: (+ endpoint: AnalyticsGroupByOptions,+ ) => Date | undefined;+ formatRows?: (rows: Record<string, unknown>[]) => Record<string, unknown>[];+};++export function getAnalyticsExportEndpoints({+ skipEndpoints = DEFAULT_SKIP_ENDPOINTS,+ skipTopLinksForSingleLink = false,+}: Pick<+ ExportAnalyticsToZipOptions,+ "skipEndpoints" | "skipTopLinksForSingleLink"+>) {+ const skipSet = new Set<string>(skipEndpoints);++ return VALID_ANALYTICS_ENDPOINTS.filter((endpoint) => {+ if (skipSet.has(endpoint)) return false;+ if (skipTopLinksForSingleLink && endpoint === "top_links") return false;+ return true;+ });+}++export async function exportAnalyticsToZip({+ params,+ workspaceId,+ useComposite,+ skipTopLinksForSingleLink = false,+ skipEndpoints = DEFAULT_SKIP_ENDPOINTS,+ getAnalyticsParams,+ getDataAvailableFrom,+ formatRows,+}: ExportAnalyticsToZipOptions) {+ const zip = new JSZip();+ const endpoints = getAnalyticsExportEndpoints({+ skipEndpoints,+ skipTopLinksForSingleLink,+ });++ for (const endpoint of endpoints) {+ const response = await getAnalytics({+ ...params,+ ...getAnalyticsParams?.(endpoint),+ workspaceId,+ groupBy: endpoint,+ event: useComposite ? "composite" : params.event,+ isDeprecatedClicksEndpoint: false,+ ...(getDataAvailableFrom?.(endpoint) && {+ dataAvailableFrom: getDataAvailableFrom(endpoint),+ }),+ });++ if (!response || (Array.isArray(response) && response.length === 0)) {+ continue;+ }++ const rows = formatRows+ ? formatRows(response as Record<string, unknown>[])+ : (response as Record<string, unknown>[]);++ zip.file(`${endpoint}.csv`, convertToCSV(rows));+ }++ return zip.generateAsync({ type: "nodebuffer" });+}++export { PARTNER_PROFILE_SKIP_ENDPOINTS };diff --git a/apps/web/tests/analytics/export-analytics-to-zip.test.ts b/apps/web/tests/analytics/export-analytics-to-zip.test.tsnew file mode 100644index 0000000000..46e2de9658--- /dev/null+++ b/apps/web/tests/analytics/export-analytics-to-zip.test.ts@@ -0,0 +1,177 @@+import {+ exportAnalyticsToZip,+ getAnalyticsExportEndpoints,+ PARTNER_PROFILE_SKIP_ENDPOINTS,+} from "@/lib/analytics/export-analytics-to-zip";+import { getAnalytics } from "@/lib/analytics/get-analytics";+import { beforeEach, describe, expect, test, vi } from "vitest";++vi.mock("@/lib/analytics/get-analytics", () => ({+ getAnalytics: vi.fn(),+}));++describe("export-analytics-to-zip", () => {+ beforeEach(() => {+ vi.mocked(getAnalytics).mockReset();+ vi.mocked(getAnalytics).mockResolvedValue([+ { clicks: 10, leads: 2, sales: 1, saleAmount: 5000 },+ ]);+ });++ describe("getAnalyticsExportEndpoints", () => {+ test("skips count by default", () => {+ const endpoints = getAnalyticsExportEndpoints({});++ expect(endpoints).not.toContain("count");+ expect(endpoints).toContain("top_links");+ });++ test("skips top_links when filtering to a single link", () => {+ const endpoints = getAnalyticsExportEndpoints({+ skipTopLinksForSingleLink: true,+ });++ expect(endpoints).not.toContain("top_links");+ });++ test("skips partner-profile endpoints", () => {+ const endpoints = getAnalyticsExportEndpoints({+ skipEndpoints: PARTNER_PROFILE_SKIP_ENDPOINTS,+ });++ expect(endpoints).not.toContain("top_partners");+ expect(endpoints).not.toContain("top_groups");+ expect(endpoints).not.toContain("top_folders");+ expect(endpoints).toContain("top_links");+ });+ });++ describe("exportAnalyticsToZip", () => {+ test("uses composite event when useComposite is true", async () => {+ await exportAnalyticsToZip({+ params: { event: "sales", interval: "30d" },+ workspaceId: "ws_123",+ useComposite: true,+ skipEndpoints: ["count", "timeseries", "continents"],+ });++ for (const call of vi.mocked(getAnalytics).mock.calls) {+ expect(call[0]?.event).toBe("composite");+ }+ });++ test("preserves client event when useComposite is false", async () => {+ await exportAnalyticsToZip({+ params: { event: "sales", interval: "30d" },+ workspaceId: "ws_123",+ useComposite: false,+ skipEndpoints: ["count", "timeseries", "continents"],+ });++ for (const call of vi.mocked(getAnalytics).mock.calls) {+ expect(call[0]?.event).toBe("sales");+ }+ });++ test("fetches endpoints sequentially", async () => {+ const callOrder: string[] = [];++ vi.mocked(getAnalytics).mockImplementation(async ({ groupBy }) => {+ callOrder.push(groupBy!);+ return [{ clicks: 1, leads: 0, sales: 0, saleAmount: 0 }];+ });++ await exportAnalyticsToZip({+ params: { event: "clicks", interval: "30d" },+ workspaceId: "ws_123",+ useComposite: false,+ skipEndpoints: [+ "count",+ "continents",+ "regions",+ "countries",+ "cities",+ "devices",+ "browsers",+ "os",+ "trigger",+ "triggers",+ "referers",+ "referer_urls",+ "top_folders",+ "top_link_tags",+ "top_domains",+ "top_urls",+ "top_base_urls",+ "top_partners",+ "top_groups",+ "top_partner_tags",+ "utm_sources",+ "utm_mediums",+ "utm_campaigns",+ "utm_terms",+ "utm_contents",+ ],+ });++ expect(callOrder).toEqual(["timeseries", "top_links"]);+ });++ test("includes composite metrics in generated zip", async () => {+ vi.mocked(getAnalytics).mockResolvedValue([+ {+ link: "link_123",+ clicks: 953,+ leads: 12,+ sales: 2,+ saleAmount: 10000,+ },+ ]);++ const zipData = await exportAnalyticsToZip({+ params: { event: "sales", interval: "30d" },+ workspaceId: "ws_123",+ useComposite: true,+ skipEndpoints: [+ "count",+ "timeseries",+ "continents",+ "regions",+ "countries",+ "cities",+ "devices",+ "browsers",+ "os",+ "trigger",+ "triggers",+ "referers",+ "referer_urls",+ "top_folders",+ "top_link_tags",+ "top_domains",+ "top_urls",+ "top_base_urls",+ "top_partners",+ "top_groups",+ "top_partner_tags",+ "utm_sources",+ "utm_mediums",+ "utm_campaigns",+ "utm_terms",+ "utm_contents",+ ],+ });++ const JSZip = (await import("jszip")).default;+ const zip = await JSZip.loadAsync(new Uint8Array(zipData));+ const topLinksCsv = await zip.file("top_links.csv")?.async("string");++ expect(topLinksCsv).toContain("clicks");+ expect(topLinksCsv).toContain("leads");+ expect(topLinksCsv).toContain("sales");+ expect(topLinksCsv).toContain("953");+ expect(topLinksCsv).toContain("12");+ expect(topLinksCsv).toContain("2");+ });+ });+});diff --git a/apps/web/ui/analytics/analytics-export-button.tsx b/apps/web/ui/analytics/analytics-export-button.tsxindex dbe64d605e..9771716681 100644--- a/apps/web/ui/analytics/analytics-export-button.tsx+++ b/apps/web/ui/analytics/analytics-export-button.tsx@@ -16,7 +16,6 @@ export function AnalyticsExportButton({async function exportData() {setLoading(true);try {- // Use partner profile export endpoint if on partner page, otherwise use regular export endpointconst exportPath = partnerPage? `${baseApiPath}/export`: "/api/analytics/export";@@ -29,8 +28,18 @@ export function AnalyticsExportButton({});if (!response.ok) {- setLoading(false);- throw new Error(response.statusText);+ let message = response.statusText;++ try {+ const body = await response.json();+ if (body?.error?.message) {+ message = body.error.message;+ }+ } catch {+ // ignore JSON parse errors+ }++ throw new Error(message);}const blob = await response.blob();@@ -40,9 +49,10 @@ export function AnalyticsExportButton({a.download = `Dub Analytics Export - ${new Date().toISOString()}.zip`;a.click();} catch (error) {- throw new Error(error);+ throw error instanceof Error ? error : new Error(String(error));+ } finally {+ setLoading(false);}- setLoading(false);}return (@@ -54,9 +64,10 @@ export function AnalyticsExportButton({onClick={() => {setOpenPopover(false);toast.promise(exportData(), {- loading: "Exporting files...",+ loading: "Exporting analytics... This may take up to a minute.",success: "Exported successfully",- error: (error) => error,+ error: (error) =>+ error instanceof Error ? error.message : "Export failed",});}}loading={loading}