diff --git a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/going-deeper/event-parameters/index.md b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/going-deeper/event-parameters/index.md index 5f9ead54b9..5ba262bfda 100644 --- a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/going-deeper/event-parameters/index.md +++ b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/going-deeper/event-parameters/index.md @@ -2,7 +2,7 @@ title: "Event parameters" --- -This page lists all the parameters that Snowplow trackers use when firing events to push data into the Snowplow collectors. Each parameter maps onto one or more fields in the Snowplow events table employed in storage. +This page lists all the parameters that Snowplow trackers use when firing events to push data into the Snowplow collectors. Each parameter maps onto one or more fields in the Snowplow events table employed in storage. This page is for you if you want to understand the tracker payload in more detail, and especially if you are building your own tracker. In the latter case, utilizing the parameters documented here will ensure that your tracker works with the rest of the Snowplow stack. @@ -62,42 +62,42 @@ If enabled, the [activity tracking function](/docs/collecting-data/collecting-fr Page pings are identified by `e=pp`. As well as all the standard web fields, there are four additional fields that `pp` includes, which are used to identify how users are scrolling over web pages: -| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | -|----------------|----------|-----------------------------------------------------|--------------------| -| `pp_mix` | `pp_xoffset_min` | integer | Minimum page x offset seen in the last ping period | `0` | -| `pp_max` | `pp_xoffset_max` | integer | Maximum page x offset seen in the last ping period | `100` | -| `pp_miy` | `pp_yoffset_min` | integer | Minimum page y offset seen in the last ping period | `0` | -| `pp_may` | `pp_yoffset_max` | integer | Maximum page y offset seen in the last ping period | `100` | +| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | +| ------------- | ---------------- | -------- | -------------------------------------------------- | ------------------ | +| `pp_mix` | `pp_xoffset_min` | integer | Minimum page x offset seen in the last ping period | `0` | +| `pp_max` | `pp_xoffset_max` | integer | Maximum page x offset seen in the last ping period | `100` | +| `pp_miy` | `pp_yoffset_min` | integer | Minimum page y offset seen in the last ping period | `0` | +| `pp_may` | `pp_yoffset_max` | integer | Maximum page y offset seen in the last ping period | `100` | #### Transaction tracking Transaction events allow you to track a transaction. The items of the transaction can be tracked using [Transaction Item events](#transaction-item-events). -| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | -|----------------|----------|------------------------------------------------------|--------------------| -| `tr_id` | `tr_orderid` | text | Order ID | `12345` | -| `tr_af` | `tr_affiliation` | text | Transaction affiliation (e.g. channel) | `Web` | -| `tr_tt` | `tr_total` | decimal | Transaction total value | `9.99` | -| `tr_tx` | `tr_tax` | decimal | Transaction tax value (i.e. amount of VAT included) | `1.98` | -| `tr_sh` | `tr_shipping` | decimal | Delivery cost charged | `3.00` | -| `tr_ci` | `tr_city` | text | Delivery address: city | `London` | -| `tr_st` | `tr_state` | text | Delivery address: state | `Denver` | -| `tr_co` | `tr_country` | text | Delivery address: country | `United Kingdom` | -| `tr_cu` | `tr_currency` | text | Transaction Currency | `GBP` | +| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | +| ------------- | ---------------- | -------- | --------------------------------------------------- | ------------------ | +| `tr_id` | `tr_orderid` | text | Order ID | `12345` | +| `tr_af` | `tr_affiliation` | text | Transaction affiliation (e.g. channel) | `Web` | +| `tr_tt` | `tr_total` | decimal | Transaction total value | `9.99` | +| `tr_tx` | `tr_tax` | decimal | Transaction tax value (i.e. amount of VAT included) | `1.98` | +| `tr_sh` | `tr_shipping` | decimal | Delivery cost charged | `3.00` | +| `tr_ci` | `tr_city` | text | Delivery address: city | `London` | +| `tr_st` | `tr_state` | text | Delivery address: state | `Denver` | +| `tr_co` | `tr_country` | text | Delivery address: country | `United Kingdom` | +| `tr_cu` | `tr_currency` | text | Transaction Currency | `GBP` | #### Transaction item events Transaction item events are separate events, representing the items of a transaction, which are linked to a Transaction event via `ti_id` which should map to `tr_id` of a transaction event. -| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | -|---------------|---------------|----------|------------------|--------------------| -| `ti_id` | `ti_orderid` | text | Order ID | `12345` | -| `ti_sk` | `ti_sku` | text | Item SKU | Yes | \`pbz0025' | -| `ti_nm` | `ti_name` | text | Item name | Yes | `black-tarot` | -| `ti_ca` | `ti_category` | text | Item category | Yes | `tarot` | -| `ti_pr` | `ti_price` | decimal | Item price | Yes | `7.99` | -| `ti_qu` | `ti_quantity` | integer | Item quantity | Yes | `2` | -| `ti_cu` | `ti_currency` | text | Currency | Yes | `USD` | +| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | +| ------------- | ---------------- | -------- | --------------- | ------------------ | +| `ti_id` | `ti_orderid` | text | Order ID | `12345` | +| `ti_sk` | `ti_sku` | text | Item SKU | `pbz0025` | +| `ti_nm` | `ti_name` | text | Item name | `black-tarot` | +| `ti_ca` | `ti_category` | text | Item category | `tarot` | +| `ti_pr` | `ti_price` | decimal | Item price | `7.99` | +| `ti_qu` | `ti_quantity` | integer | Item quantity | `2` | +| `ti_cu` | `ti_currency` | text | Currency | `USD` | #### Structured event tracking @@ -111,13 +111,13 @@ We recommend using [self-describing events](#self-describing-events) for custom As well as setting `e=se`, there are five custom event specific parameters that can be set: -| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | -|---------------|---------------|----------|-------------------------------------------------------------------------|-------------------------------| -| `se_ca` | `se_category` | text | The category of event | `Ecomm`, `Media` | -| `se_ac` | `se_action` | text | The action / event itself | `add-to-basket`, `play-video` | -| `se_la` | `se_label` | text | A label often used to refer to the 'object' the action is performed on | `dog-skateboarding-video` | -| `se_pr` | `se_property` | text | A property associated with either the action or the object | `hd` | -| `se_va` | `se_value` | decimal | A value associated with the user action | `13.99` | +| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | +| ------------- | ---------------- | -------- | ---------------------------------------------------------------------- | ----------------------------- | +| `se_ca` | `se_category` | text | The category of event | `Ecomm`, `Media` | +| `se_ac` | `se_action` | text | The action / event itself | `add-to-basket`, `play-video` | +| `se_la` | `se_label` | text | A label often used to refer to the 'object' the action is performed on | `dog-skateboarding-video` | +| `se_pr` | `se_property` | text | A property associated with either the action or the object | `hd` | +| `se_va` | `se_value` | decimal | A value associated with the user action | `13.99` | ### Event Entity Tracking @@ -128,10 +128,10 @@ To learn about context entities and how they are serialized in the event payload ### Event parameters -| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | -|---------------|-----------------------|----------|------------------|----------------------------------------| -| `e` | `event` | text | Event type | (See table [above](#snowplow-events)) | -| `eid` | `event_id` | text | Event UUID | `606adff6-9ccc-41f4-8807-db8fdb600df8` | +| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | +| ------------- | ---------------- | -------- | --------------- | -------------------------------------- | +| `e` | `event` | text | Event type | (See table [above](#snowplow-events)) | +| `eid` | `event_id` | text | Event UUID | `606adff6-9ccc-41f4-8807-db8fdb600df8` | :::caution @@ -147,12 +147,12 @@ The event ID (`eid`) is the unique identifier (UUID) for this row. This should b ### Application parameters -| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | -|---------------|-----------------------------|----------|----------------------------------------------|-------------------------| -| `tna` | `name_tracker` | text | The tracker namespace | `tracker_1` | -| `aid` | `app_id` | text | Unique identifier for website / application | `snow-game-android` | -| `p` | `platform` | text | The platform the app runs on | `web`, `mob`, `app` | -| `tv` | `v_tracker` | text | Identifier for Snowplow tracker | `js-2.16.2` | +| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | +| ------------- | ---------------- | -------- | ------------------------------------------- | ------------------- | +| `tna` | `name_tracker` | text | The tracker namespace | `tracker_1` | +| `aid` | `app_id` | text | Unique identifier for website / application | `snow-game-android` | +| `p` | `platform` | text | The platform the app runs on | `web`, `mob`, `app` | +| `tv` | `v_tracker` | text | Identifier for Snowplow tracker | `js-2.16.2` | :::info @@ -175,7 +175,7 @@ The tracker namespace parameter is used to distinguish between different tracker ### Timestamp parameters -| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | +| **Parameter** | **Table Column** | **Type** | **Description** | **Example values** | |---------------|-----------------------|----------|--------------------------------------------------------------|--------------------| | `dtm` | `dvce_created_tstamp` | int | Timestamp when event occurred, as recorded by client device | `1361553733313` | | `stm` | `dvce_sent_tstamp` | int | Timestamp when event was sent by client device to collector | `1361553733371` | diff --git a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/app-performance/index.md b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/app-performance/index.md index cf59ade49c..427b6e045e 100644 --- a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/app-performance/index.md +++ b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/app-performance/index.md @@ -46,8 +46,8 @@ To process raw web vitals event data, we have included an optional module to mod This custom module consists of a series of dbt models which produce the following aggregated models from the raw web vitals events: -Derived table | Table description | ----|---|--- +Derived table | Table description | +---|--- `snowplow_web_vitals` | Incremental table used as a base for storing core web vital events (first event per page view). | [Docs](https://snowplow.github.io/dbt-snowplow-web/#!/model/model.snowplow_web.snowplow_web_vitals) `snowplow_web_vital_measurements` | Drop and recompute table to use for visualizations that takes core web vital measurements at the user specified percentile point (defaulted to 75). | [Docs](https://snowplow.github.io/dbt-snowplow-web/#!/model/model.snowplow_web.snowplow_web_vital_measurements) diff --git a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/consent-events/index.md b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/consent-events/index.md index dacc93a0c5..b7fceee8e5 100644 --- a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/consent-events/index.md +++ b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/consent-events/index.md @@ -44,7 +44,7 @@ To process raw events created by the Snowplow Enhanced Consent plugin we have in This custom module consists of a series of dbt models which produce the following aggregated models from the raw consent tracking events: -Derived table | Table description | +Derived table | Table description | dbt ---|---|--- `snowplow_web_consent_log` | Snowplow incremental table showing the audit trail of consent and Consent Management Platform (cmp) events | [Docs](https://snowplow.github.io/dbt-snowplow-web/#!/model/model.snowplow_web.snowplow_web_consent_log) `snowplow_web_consent_users` | Incremental table of user consent tracking stats | [Docs](https://snowplow.github.io/dbt-snowplow-web/#!/model/model.snowplow_web.snowplow_web_consent_users) diff --git a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/ecommerce-events/index.md b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/ecommerce-events/index.md index b01022554e..58c0e43c7b 100644 --- a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/ecommerce-events/index.md +++ b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/ecommerce-events/index.md @@ -156,7 +156,7 @@ All tracked e-commerce properties are tracked as context entities. [The package](/docs/modeling-your-data/modeling-your-data-with-dbt/dbt-models/dbt-ecommerce-data-model/index.md) contains a fully incremental model that transforms raw e-commerce event data into a set of derived tables based around the following e-commerce data objects: carts, checkouts, products and transactions. -Derived table | Table description | +Derived table | Table description | dbt ---|---|--- `snowplow_ecommerce_base_events_this_run` | Base: Performs the incremental logic, the table contains a de-duped data set of all events required for the current run of the model, and is the foundation for all other models generated. | [Docs](https://snowplow.github.io/dbt-snowplow-ecommerce/#!/model/model.snowplow_ecommerce.snowplow_ecommerce_base_sessions_this_run) `snowplow_ecommerce_cart_interactions` | Carts: Parses the cart interactions that occur to provide handy filters and aggregations, which helps identify what happened to carts on a session level to extract, for example, abandoned carts with ease. | [Docs](https://snowplow.github.io/dbt-snowplow-ecommerce/#!/model/model.snowplow_ecommerce.snowplow_ecommerce_cart_interactions) @@ -167,7 +167,7 @@ Derived table | Table description | ## E-commerce analytics accelerator -Follow the [e-commerce accelerator](https://snowplow.io/data-product-accelerators/ecommerce-analytics-dpa/) for a complete guide to build a deeper understanding of customer behavior in your ecommerce store. +Follow the [e-commerce accelerator](https://snowplow.io/data-product-accelerators/ecommerce-analytics-dpa/) for a complete guide to build a deeper understanding of customer behavior in your ecommerce store.
Old e-commerce events diff --git a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/media-events/index.md b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/media-events/index.md index 6bf39870a8..c796cd845a 100644 --- a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/media-events/index.md +++ b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/media-events/index.md @@ -321,7 +321,7 @@ They consist of the following events and context entities: [The media player dbt package](/docs/modeling-your-data/modeling-your-data-with-dbt/dbt-models/dbt-media-player-data-model/index.md) contains a fully incremental model that transforms raw media event data into a set of derived tables based around the following data objects: media plays, media stats, media ad views, and media ads. -Derived table | Table description | +Derived table | Table description | dbt ---|---|--- `snowplow_media_player_base` | This derived table summarises the key media player events and metrics of each media element on a media_id and pageview level which is considered as a base aggregation level for media interactions. | [Docs](https://snowplow.github.io/dbt-snowplow-media-player/#!/model/model.snowplow_media_player.snowplow_media_player_base) `snowplow_media_player_plays_by_pageview` | This view removes impressions from the '_base' table to summarise media plays on a page_view by media_id level. | [Docs](https://snowplow.github.io/dbt-snowplow-media-player/#!/model/model.snowplow_media_player.snowplow_media_player_plays_by_pageview) diff --git a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/page-activity-tracking/index.md b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/page-activity-tracking/index.md index 561b4e800a..6747c66db7 100644 --- a/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/page-activity-tracking/index.md +++ b/docs/collecting-data/collecting-from-own-applications/snowplow-tracker-protocol/ootb-data/page-activity-tracking/index.md @@ -20,12 +20,12 @@ If enabled, the [activity tracking function](/docs/collecting-data/collecting-fr Page pings are identified by `e=pp`. As well as all the standard web fields, there are four additional fields that `pp` includes, which are used to identify how users are scrolling over web pages: -| **Atomic Table Column** | **Type** | **Description** | **Example values** | -|----------|-----------------------------------------------------|--------------------| -| `pp_xoffset_min` | integer | Minimum page x offset seen in the last ping period | `0` | -| `pp_xoffset_max` | integer | Maximum page x offset seen in the last ping period | `100` | -| `pp_yoffset_min` | integer | Minimum page y offset seen in the last ping period | `0` | -| `pp_yoffset_max` | integer | Maximum page y offset seen in the last ping period | `100` | +| **Atomic Table Column** | **Type** | **Description** | **Example values** | +| ----------------------- | -------- | -------------------------------------------------- | ------------------ | +| `pp_xoffset_min` | integer | Minimum page x offset seen in the last ping period | `0` | +| `pp_xoffset_max` | integer | Maximum page x offset seen in the last ping period | `100` | +| `pp_yoffset_min` | integer | Minimum page y offset seen in the last ping period | `0` | +| `pp_yoffset_max` | integer | Maximum page y offset seen in the last ping period | `100` | ## On mobile diff --git a/docs/understanding-tracking-design/defining-the-data-to-collect-with-data-poducts/index.md b/docs/understanding-tracking-design/defining-the-data-to-collect-with-data-poducts/index.md index 6a520cd7c4..690413d788 100644 --- a/docs/understanding-tracking-design/defining-the-data-to-collect-with-data-poducts/index.md +++ b/docs/understanding-tracking-design/defining-the-data-to-collect-with-data-poducts/index.md @@ -4,7 +4,7 @@ sidebar_position: 2 sidebar_label: "🆕 Defining the Data to collect with Data Products" --- -As described in [Data Products Introduction](/docs/understanding-your-pipeline/data-products/index.md), a data product is a logical grouping of the data you collect as an organisation by domain, with an explicit owner. +As described in [Data Products Introduction](/docs/understanding-your-pipeline/data-products/index.md), a data product is a logical grouping of the data you collect as an organisation by domain, with an explicit owner. With data products, you can: @@ -21,13 +21,13 @@ With data products, you can: - **Name;** a descriptive name for the data product - **Description;** a description of the data that the data product captures -- **Owner;** the individual responsible for the data product +- **Owner;** the individual responsible for the data product - **Domain;** the team or business domain that owns the data product - **Event specifications** - * **Name;** a descriptive name for the event + * **Name;** a descriptive name for the event * **Description;** a description to help people understand what action the event is capturing * **Applications;** the application/s that the event will be tracked on - * ** Triggers;** specific instructions on where the event gets triggered (e.g. when a user clicks the "Add to basket" button) + * **Triggers;** specific instructions on where the event gets triggered (e.g. when a user clicks the "Add to basket" button) * **Event data structure;** the event data structure that this event will validate against as it is processed by your pipeline * **Entities;** the entities that should be attached to this event (e.g. user, product) * **Properties;** any specific rules for each property of the event