Skip to content

middleware: add data-pathname attribute for custom pathname handling #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tinydaniel merged 1 commit into from
Mar 26, 2026
Merged

middleware: add data-pathname attribute for custom pathname handling #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ These parameters can be used with the tracker snippet:
| `data-proxy-url` | No | A complete proxy URL endpoint for the tracking request. Use this when you need to specify a custom tracking endpoint beyond just the domain. Cannot be used together with `data-proxy`. |
| `data-host` | No | Tinybird host URL. Defaults to `https://api.tinybird.co/`, but could be `https://api.us-east.tinybird.co` or a dedicated cluster. The banner already generates the snippet with the proper host. |
| `data-datasource` | No | If you iterate the landing data source, or you just want to ingest the event in a different one, you can specify the landing data source name.
| `data-pathname` | No | Override the `pathname` field sent with every event. Useful for SPAs where `window.location` is polluted with campaign parameters, or when you need to send a virtual/canonical URL (e.g. a content ID instead of the full path).
| `web-vitals` | No | Tracks web vitals using the [web-vitals](https://www.npmjs.com/package/web-vitals) library

### Implementing custom attributes
Expand Down
7 changes: 4 additions & 3 deletions middleware/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@
let globalAttributes = {}
let stringifyPayload = true

let proxy, proxyUrl, token, host, domain, tenantId
let proxy, proxyUrl, token, host, domain, tenantId, customPathname
if (document.currentScript) {
host = document.currentScript.getAttribute('data-host')
proxy = document.currentScript.getAttribute('data-proxy')
proxyUrl = document.currentScript.getAttribute('data-proxy-url')
token = document.currentScript.getAttribute('data-token')
domain = document.currentScript.getAttribute('data-domain') || ''
tenantId = document.currentScript.getAttribute('data-tenant-id') || ''
customPathname = document.currentScript.getAttribute('data-pathname') || ''

// Check if both proxy and proxyUrl are specified
if (proxy && proxyUrl) {
Expand Down Expand Up @@ -322,7 +323,7 @@
locale,
location: country,
referrer: document.referrer,
pathname: window.location.pathname,
pathname: customPathname || window.location.pathname,
href: window.location.href,
})
}, 300)
Expand All @@ -339,7 +340,7 @@
rating: metric.rating,
id: metric.id,
navigationType: metric.navigationType,
pathname: window.location.pathname,
pathname: customPathname || window.location.pathname,
href: window.location.href,
'user-agent': window.navigator.userAgent,
locale,
Expand Down
Loading