-
Notifications
You must be signed in to change notification settings - Fork 4
Add more details about cross-domain tracking #1210
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.
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
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
63fe8fb
Add note about base64 encoding
mscwilson fc2f463
Tidy up the file
mscwilson d86dfc6
Add useExtendedCrossDomainLinker to JS initialisation options
mscwilson 3f6e704
Tidy up the file
mscwilson 4bce90d
Add updated info
mscwilson 314d6e4
Tidy up pages
mscwilson f724caa
Make changes following review
mscwilson 1ea0333
Merge branch 'main' into add_details_cross_navigation
mscwilson 4fd1a93
Update mobile page
mscwilson cb15319
Remove accidentally committed settings file
mscwilson c5eec09
Make review changes
mscwilson e542bf7
Apply suggestions from code review
mscwilson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: "Cross-navigation tracking" | ||
| description: "Configure cross-domain tracking to maintain user identity between different domains in your ecosystem" | ||
| date: "2025-07-26" | ||
| sidebar_position: 5 | ||
| --- | ||
|
|
||
| When users navigate between different domains in your ecosystem, their user identity may get fragmented. Examples include navigation from your main website to a partner site, or to a mobile app. This creates gaps in your user journey data and makes it difficult to understand the complete customer experience across your digital properties. | ||
|
|
||
| :::info Web subdomains | ||
| This problem doesn't usually apply for navigation between web subdomains, for example between `www.example.com` and `blog.example.com`. This is because the web trackers have `discoverRootDomain` [enabled by default](/docs/sources/trackers/web-trackers/tracker-setup/initialization-options/index.md). | ||
| ::: | ||
|
|
||
| Cross-navigation (also called cross-domain) tracking solves this problem by passing user identification data in URL parameters when users click links to other domains. This enables you to maintain user continuity across your applications. | ||
|
|
||
| To use cross-navigation tracking, configure the [web](/docs/sources/trackers/web-trackers/cross-domain-tracking/index.md) or [native mobile](/docs/sources/trackers/mobile-trackers/tracking-events/session-tracking/index.md#decorating-outgoing-links-using-cross-navigation-tracking) trackers to add an additional parameter, named `_sp`, to the querystring of outbound links. This process is called "link decoration". | ||
|
|
||
| Link decoration makes the added values visible in the `url` field of events on the destination page or URI. The querystring is added only to the events at the destination page: it doesn't persist throughout the user's session. | ||
|
|
||
| ## Querystring properties | ||
|
|
||
| The `_sp` querystring parameter has two different formats: extended or short. You can also configure exactly which properties you want to include. | ||
|
|
||
| Available properties: | ||
|
|
||
| | Property | Description | Extended | Short | | ||
| | ---------------- | ---------------------------------------------- | -------- | ----- | | ||
| | `domainUserId` | Current tracker-generated UUID user identifier | ✅ | ✅ | | ||
| | `timestamp` | Current epoch timestamp, millisecond precision | ✅ | ✅ | | ||
| | `sessionId` | Current session UUID identifier | ✅ | | | ||
| | `subjectUserId` | Custom business user identifier | ✅ | | | ||
| | `sourceId` | Application identifier | ✅ | | | ||
| | `sourcePlatform` | Platform of the current device | ✅ | | | ||
| | `reason` | Custom information or identifier | ✅ | | | ||
|
|
||
| For example, the link `appSchema://path/to/page` would look like this after decoration with the full extended format: | ||
|
|
||
| ``` | ||
| appSchema://path/to/page?_sp=domainUserId.timestamp.sessionId.subjectUserId.sourceId.sourcePlatform.reason | ||
| ``` | ||
|
|
||
| ## How are the querystring parameters processed? | ||
|
|
||
| By default, your pipeline will process only the short format querystring `_sp={domainUserId}.{timestamp}`, even if you've decorated the links with the extended format. To process the extra properties, you'll need to configure the [cross-navigation enrichment](/docs/pipeline/enrichments/available-enrichments/cross-navigation-enrichment/index.md). | ||
|
|
||
| Both default and extended formats will populate the [atomic](/docs/fundamentals/canonical-event/index.md) `refr_domain_userid` and `refr_dvce_tstamp` fields. The enrichment also adds a `cross_navigation` entity to the event. | ||
|
|
||
| | Feature | Default behavior | With cross-navigation enrichment | | ||
| | ------------------------------------------------------- | ---------------- | -------------------------------- | | ||
| | Processes short format `_sp={domainUserId}.{timestamp}` | ✅ | ✅ | | ||
| | Processes extended format properties | ❌ | ✅ | | ||
| | Populates `refr_domain_userid` field | ✅ | ✅ | | ||
| | Populates `refr_dvce_tstamp` field | ✅ | ✅ | | ||
| | Adds `cross_navigation` entity | ❌ | ✅ | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.