Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

fix: email utm tags

Carl-Gerhard Lindesvärdce1f7a9fad52
diff --git a/packages/email/src/emails/onboarding-dashboards.tsx b/packages/email/src/emails/onboarding-dashboards.tsx
index c4d0bf539..1f0892d0e 100644
--- a/packages/email/src/emails/onboarding-dashboards.tsx
+++ b/packages/email/src/emails/onboarding-dashboards.tsx
@@ -3,6 +3,7 @@ import React from 'react';
import { z } from 'zod';
import { Layout } from '../components/layout';
import { List } from '../components/list';
+import { withUtm } from '../utm';
export const zOnboardingDashboards = z.object({
firstName: z.string().optional(),
@@ -23,11 +24,6 @@ export function OnboardingDashboards({
eventsCount,
unsubscribeUrl,
}: Props & { unsubscribeUrl?: string }) {
- const newUrl = new URL(dashboardUrl);
- newUrl.searchParams.set('utm_source', 'email');
- newUrl.searchParams.set('utm_medium', 'email');
- newUrl.searchParams.set('utm_campaign', 'onboarding-dashboards');
-
if (!hasData) {
return (
<Layout unsubscribeUrl={unsubscribeUrl}>
@@ -40,7 +36,10 @@ export function OnboardingDashboards({
If you still want to try OpenPanel, the install is the only thing in
the way:{' '}
<Link
- href={'https://openpanel.dev/docs/get-started/install-openpanel'}
+ href={withUtm(
+ 'https://openpanel.dev/docs/get-started/install-openpanel',
+ 'onboarding-dashboards',
+ )}
>
install guide
</Link>
@@ -76,7 +75,10 @@ export function OnboardingDashboards({
/>
<Text>
Takes about ten minutes:{' '}
- <Link href={newUrl.toString()}>build a dashboard</Link>.
+ <Link href={withUtm(dashboardUrl, 'onboarding-dashboards')}>
+ build a dashboard
+ </Link>
+ .
</Text>
<Text>
Once it exists you'll actually open it. That's the difference between
diff --git a/packages/email/src/emails/onboarding-feature-request.tsx b/packages/email/src/emails/onboarding-feature-request.tsx
index fbca2ef7d..772723ca0 100644
--- a/packages/email/src/emails/onboarding-feature-request.tsx
+++ b/packages/email/src/emails/onboarding-feature-request.tsx
@@ -2,6 +2,7 @@ import { Link, Text } from '@react-email/components';
import React from 'react';
import { z } from 'zod';
import { Layout } from '../components/layout';
+import { withUtm } from '../utm';
export const zOnboardingFeatureRequest = z.object({
firstName: z.string().optional(),
@@ -25,7 +26,7 @@ export function OnboardingFeatureRequest({
<Text>
Just reply to this email. If you'd rather post publicly, the feedback
board is at{' '}
- <Link href={'https://feedback.openpanel.dev'}>
+ <Link href={withUtm('https://feedback.openpanel.dev', 'onboarding-feature-request')}>
feedback.openpanel.dev
</Link>
.
diff --git a/packages/email/src/emails/onboarding-trial-ended.tsx b/packages/email/src/emails/onboarding-trial-ended.tsx
index 399277fc5..a2b40590b 100644
--- a/packages/email/src/emails/onboarding-trial-ended.tsx
+++ b/packages/email/src/emails/onboarding-trial-ended.tsx
@@ -3,6 +3,7 @@ import React from 'react';
import { z } from 'zod';
import { Button } from '../components/button';
import { Layout } from '../components/layout';
+import { withUtm } from '../utm';
export const zOnboardingTrialEnded = z.object({
firstName: z.string().optional(),
@@ -25,11 +26,6 @@ export function OnboardingTrialEnded({
eventsCount,
unsubscribeUrl,
}: Props & { unsubscribeUrl?: string }) {
- const newUrl = new URL(billingUrl);
- newUrl.searchParams.set('utm_source', 'email');
- newUrl.searchParams.set('utm_medium', 'email');
- newUrl.searchParams.set('utm_campaign', 'onboarding-trial-ended');
-
if (!hasData) {
return (
<Layout unsubscribeUrl={unsubscribeUrl}>
@@ -65,7 +61,9 @@ export function OnboardingTrialEnded({
: 'Plans start at $2.50 a month.'}
</Text>
<Text>
- <Button href={newUrl.toString()}>Upgrade</Button>
+ <Button href={withUtm(billingUrl, 'onboarding-trial-ended')}>
+ Upgrade
+ </Button>
</Text>
<Text>
If you don't upgrade, the workspace is eventually removed along with
diff --git a/packages/email/src/emails/onboarding-trial-ending.tsx b/packages/email/src/emails/onboarding-trial-ending.tsx
index fb88787f7..af1a95047 100644
--- a/packages/email/src/emails/onboarding-trial-ending.tsx
+++ b/packages/email/src/emails/onboarding-trial-ending.tsx
@@ -3,6 +3,7 @@ import React from 'react';
import { z } from 'zod';
import { Button } from '../components/button';
import { Layout } from '../components/layout';
+import { withUtm } from '../utm';
export const zOnboardingTrialEnding = z.object({
firstName: z.string().optional(),
@@ -27,11 +28,6 @@ export function OnboardingTrialEnding({
eventsCount,
unsubscribeUrl,
}: Props & { unsubscribeUrl?: string }) {
- const newUrl = new URL(billingUrl);
- newUrl.searchParams.set('utm_source', 'email');
- newUrl.searchParams.set('utm_medium', 'email');
- newUrl.searchParams.set('utm_campaign', 'onboarding-trial-ending');
-
const endsOn = trialEndDate ? `on ${trialEndDate}` : 'in a few days';
if (!hasData) {
@@ -46,7 +42,10 @@ export function OnboardingTrialEnding({
If the timing was just off, you can install now and use the last few
days to see if it's useful:{' '}
<Link
- href={'https://openpanel.dev/docs/get-started/install-openpanel'}
+ href={withUtm(
+ 'https://openpanel.dev/docs/get-started/install-openpanel',
+ 'onboarding-trial-ending',
+ )}
>
install guide
</Link>
@@ -79,7 +78,9 @@ export function OnboardingTrialEnding({
workspace is removed.
</Text>
<Text>
- <Button href={newUrl.toString()}>Upgrade</Button>
+ <Button href={withUtm(billingUrl, 'onboarding-trial-ending')}>
+ Upgrade
+ </Button>
</Text>
<Text>
If something is holding you back, reply and tell me. I'd rather fix the
diff --git a/packages/email/src/emails/onboarding-welcome.tsx b/packages/email/src/emails/onboarding-welcome.tsx
index 35f4f6e08..ab0a3eb83 100644
--- a/packages/email/src/emails/onboarding-welcome.tsx
+++ b/packages/email/src/emails/onboarding-welcome.tsx
@@ -3,6 +3,7 @@ import React from 'react';
import { z } from 'zod';
import { Layout } from '../components/layout';
import { List } from '../components/list';
+import { withUtm } from '../utm';
export const zOnboardingWelcome = z.object({
firstName: z.string().optional(),
@@ -33,7 +34,9 @@ export function OnboardingWelcome({
look around your dashboard and reply if anything looks off.
</Text>
<Text>
- <Link href={dashboardUrl}>Open your dashboard</Link>
+ <Link href={withUtm(dashboardUrl, 'onboarding-welcome')}>
+ Open your dashboard
+ </Link>
</Text>
</>
) : (
@@ -46,13 +49,19 @@ export function OnboardingWelcome({
items={[
<Link
key="install"
- href={'https://openpanel.dev/docs/get-started/install-openpanel'}
+ href={withUtm(
+ 'https://openpanel.dev/docs/get-started/install-openpanel',
+ 'onboarding-welcome',
+ )}
>
Install the tracking script
</Link>,
<Link
key="track"
- href={'https://openpanel.dev/docs/get-started/track-events'}
+ href={withUtm(
+ 'https://openpanel.dev/docs/get-started/track-events',
+ 'onboarding-welcome',
+ )}
>
Track custom events
</Link>,
diff --git a/packages/email/src/emails/onboarding-what-to-track.tsx b/packages/email/src/emails/onboarding-what-to-track.tsx
index be1c6893a..fb9dfa1bd 100644
--- a/packages/email/src/emails/onboarding-what-to-track.tsx
+++ b/packages/email/src/emails/onboarding-what-to-track.tsx
@@ -2,6 +2,7 @@ import { Link, Text } from '@react-email/components';
import React from 'react';
import { z } from 'zod';
import { Layout } from '../components/layout';
+import { withUtm } from '../utm';
export const zOnboardingWhatToTrack = z.object({
firstName: z.string().optional(),
@@ -54,7 +55,10 @@ export function OnboardingWhatToTrack({
Usually that means the install didn't happen, or something is
blocking the script. Both are quick to sort out:{' '}
<Link
- href={'https://openpanel.dev/docs/get-started/install-openpanel'}
+ href={withUtm(
+ 'https://openpanel.dev/docs/get-started/install-openpanel',
+ 'onboarding-what-to-track',
+ )}
>
install guide
</Link>
diff --git a/packages/email/src/emails/weekly-digest.tsx b/packages/email/src/emails/weekly-digest.tsx
index 6fa22242c..bb8b9bd37 100644
--- a/packages/email/src/emails/weekly-digest.tsx
+++ b/packages/email/src/emails/weekly-digest.tsx
@@ -3,6 +3,7 @@ import React from 'react';
import { z } from 'zod';
import { Layout } from '../components/layout';
import { List } from '../components/list';
+import { withUtm } from '../utm';
export const zWeeklyDigest = z.object({
projectName: z.string(),
@@ -86,7 +87,9 @@ export function WeeklyDigest({
)}
<Section className="mt-6">
- <Link href={dashboardUrl}>Open your dashboard →</Link>
+ <Link href={withUtm(dashboardUrl, 'weekly-digest')}>
+ Open your dashboard →
+ </Link>
</Section>
</Layout>
);
diff --git a/packages/email/src/utm.ts b/packages/email/src/utm.ts
new file mode 100644
index 000000000..49b5fb303
--- /dev/null
+++ b/packages/email/src/utm.ts
@@ -0,0 +1,15 @@
+/**
+ * Append consistent UTM params to a link used in an email.
+ *
+ * Convention:
+ * - utm_source: always `openpanel` (the sender/product)
+ * - utm_medium: always `email` (the channel — groups all email traffic)
+ * - utm_campaign: the specific email/template (distinguishes emails)
+ */
+export function withUtm(url: string, campaign: string): string {
+ const next = new URL(url);
+ next.searchParams.set('utm_source', 'openpanel');
+ next.searchParams.set('utm_medium', 'email');
+ next.searchParams.set('utm_campaign', campaign);
+ return next.toString();
+}