Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Add `data-track-query` attribute to enhance privacy in tracking

Bill Yang36c8e20aa74d
diff --git a/docs/src/content/tracker.mdx b/docs/src/content/tracker.mdx
index c959b8384..da8e0107b 100644
--- a/docs/src/content/tracker.mdx
+++ b/docs/src/content/tracker.mdx
@@ -22,6 +22,13 @@ Set to `"false"` to disable automatic pageview tracking for single page applicat
- **Default:** `"true"`
- **Example:** `data-track-spa="false"`
+### `data-track-query`
+
+Set to `"false"` to disable tracking of URL query strings. This enhances privacy by preventing potentially sensitive information in query parameters (such as session tokens, search queries, or UTM parameters) from being stored in your analytics data.
+
+- **Default:** `"true"`
+- **Example:** `data-track-query="false"`
+
### `data-skip-patterns`
A JSON string array of URL path patterns to ignore. Pageviews matching these patterns won't be tracked. Use `*` as a wildcard for path segments (e.g., `/admin/*`).
@@ -55,6 +62,7 @@ The delay (in milliseconds) before tracking a pageview after URL changes via the
data-auto-track="false"
data-skip-patterns='["/admin"]'
data-mask-patterns='["/user/*/dashboard"]'
+ data-track-query="false"
></script>
```
diff --git a/server/public/script.js b/server/public/script.js
index 1177e8779..00253db0b 100644
--- a/server/public/script.js
+++ b/server/public/script.js
@@ -23,6 +23,8 @@
: 500;
const autoTrackSpa = scriptTag.getAttribute("data-track-spa") !== "false";
+ const trackQuerystring =
+ scriptTag.getAttribute("data-track-query") !== "false";
let skipPatterns = [];
try {
@@ -103,7 +105,7 @@
site_id: SITE_ID,
hostname: url.hostname,
pathname: pathname,
- querystring: url.search,
+ querystring: trackQuerystring ? url.search : "",
screenWidth: window.innerWidth,
screenHeight: window.innerHeight,
language: navigator.language,