Skip to content

Commit

Permalink
Revert "Remove Cross Navigation Enrichment for the time being"
Browse files Browse the repository at this point in the history
This reverts commit 451d231.
  • Loading branch information
stanch committed Jun 21, 2024
1 parent b219b54 commit cbe1081
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "Cross Navigation Enrichment"
sidebar_position: 5
sidebar_label: Cross Navigation
---

This enrichment parses the extended cross navigation format in `_sp` querystring parameter and attaches the `cross_navigation` context to an event.

The `_sp` parameter can be attached by our Web ([see cross-domain tracking](/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/cross-domain-tracking/index.md)) and [mobile trackers](/docs/collecting-data/collecting-from-own-applications/mobile-trackers/tracking-events/session-tracking/index.md#decorating-outgoing-links-using-cross-navigation-tracking) and contains user, session and app identifiers (e.g., domain user and session IDs, business user ID, source app ID). The information to include in the parameters is configurable in the trackers. This is useful for tracking the movement of users across different apps and platforms.

The extended cross navigation format can be described by `_sp={domainUserId}.{timestamp}.{sessionId}.{subjectUserId}.{sourceId}.{platform}.{reason}`

If this enrichment isn't enabled, Enrich parses `_sp` querystring parameter according to the old format, `_sp={domainUserId}.{timestamp}`

## Configuration

- [Schema](https://github.com/snowplow/iglu-central/blob/master/schemas/com.snowplowanalytics.snowplow.enrichments/cross_navigation_config/jsonschema/1-0-0)
- [Example](https://github.com/snowplow/enrich/blob/master/config/enrichments/cross_navigation_config.json)

```mdx-code-block
import TestingWithMicro from "@site/docs/reusable/test-enrichment-with-micro/_index.md"
<TestingWithMicro/>
```

## Input

This enrichment extracts `_sp` querystring parameter from the following inputs:

- The `page_url` field from the Snowplow event
- The referer uri extracted from corresponding HTTP header in the raw event

## Output

This enrichment adds a new derived context to the enriched event with [this schema](https://github.com/snowplow/iglu-central/blob/master/schemas/com.snowplowanalytics.snowplow/cross_navigation/jsonschema/1-0-0).

Also, it continues to populate `refr_domain_userid` and `refr_dvce_tstamp` enriched event fields as before.
1 change: 1 addition & 0 deletions docs/enriching-your-data/available-enrichments/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ It’s not possible to configure more than one instance of the same enrichment e
| [Currency Conversion](/docs/enriching-your-data/available-enrichments/currency-conversion-enrichment/index.md) | Convert the values of all transactions to a specified base currency using Open Exchange Rates API. *(Please note the [limitations](/docs/enriching-your-data/available-enrichments/currency-conversion-enrichment/index.md).)* |
| [Referer Parser](/docs/enriching-your-data/available-enrichments/referrer-parser-enrichment/index.md) | Extracts attribution data from referer URLs. |
| [Campaign Attribution](/docs/enriching-your-data/available-enrichments/campaign-attribution-enrichment/index.md) | Choose which querystring parameters will be used to generate the marketing campaign fields. *If you do not enable the campaign_attribution enrichment, those fields will not be populated.* |
| [Cross Navigation Enrichment](/docs/enriching-your-data/available-enrichments/cross-navigation-enrichment/index.md) | Parse the extended cross navigation format in _sp querystring parameter and attach the cross_navigation context to an event. (>= Enrich 4.1.0) |
| [Event Fingerprint](/docs/enriching-your-data/available-enrichments/event-fingerprint-enrichment/index.md) | Generate a fingerprint for the event using a hash of client-set fields. Helpful for deduplicating events. |
| [Cookie Extractor](/docs/enriching-your-data/available-enrichments/cookie-extractor-enrichment/index.md) | Specify cookies that you want to extract if found. |
| [HTTP Header Extractor](/docs/enriching-your-data/available-enrichments/http-header-extractor-enrichment/index.md) | Specify headers that you want to extract via a regex pattern, if found each extracted header will be attached to your event. |
Expand Down

0 comments on commit cbe1081

Please sign in to comment.