ref → via

dubinc · Oct 2, 2024 · 324dff9 · 324dff9
1 parent 9dd1a02
commit 324dff9
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/packages/script/src/index.js b/packages/script/src/index.js
@@ -46,7 +46,7 @@
       apiKey: ak,
       attributionModel: am || 'last-click',
       cookieOptions: co ? JSON.parse(co) : null,
-      queryParam: qp || 'ref',
+      queryParam: qp || 'via',
     };
   }
 
@@ -126,7 +126,7 @@
       return;
     }
 
-    // When the identifier is present in the URL, track the click and set the cookie (?ref=...)
+    // When the identifier is present in the URL, track the click and set the cookie
     const identifier = searchParams.get(queryParam);
 
     if (!identifier) {

diff --git a/packages/web/README.md b/packages/web/README.md
@@ -79,7 +79,7 @@ import { Analytics as DubAnalytics } from "@dub/analytics"
 
 ### `queryParam`
 
-The query parameter to listen to for client-side click-tracking (e.g. `?ref=abc123`). The default is `ref`.
+The query parameter to listen to for client-side click-tracking (e.g. `?via=john`, `?ref=jane`). The default is `via`.
 
 ### `scriptProps`
 

diff --git a/packages/web/src/types.ts b/packages/web/src/types.ts
@@ -114,9 +114,9 @@ export interface AnalyticsProps {
   };
 
   /**
-   * The query parameter to listen to for client-side click-tracking (e.g. `?ref=abc123`)
+   * The query parameter to listen to for client-side click-tracking (e.g. `?via=john`, `?ref=jane`).
    *
-   * @default 'ref'
+   * @default 'via'
    */
   queryParam?: string;