diff --git a/docs/understanding-your-pipeline/canonical-event/events-table-in-a-single-table/index.md b/docs/understanding-your-pipeline/canonical-event/events-table-in-a-single-table/index.md new file mode 100644 index 0000000000..c82ab49fea --- /dev/null +++ b/docs/understanding-your-pipeline/canonical-event/events-table-in-a-single-table/index.md @@ -0,0 +1,136 @@ +--- +title: "Snowplow Events Table in a Single Table" +sidebar_label: "Events Table Format" +sidebar_position: 1000 +--- + +Nr | Field | Type | Category | Description | Reqd? | Example +----|--------------------------|-----------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|--------------------------------------------------------------- +001 | app_id | text | Application fields | Application ID | Yes | 'angry-birds' +002 | platform | text | Application fields | Platform, limited to specific values | Yes | 'web' +003 | collector_tstamp | timestamp | Date / time fields | Timestamp for the event recorded by the collector | Yes | '2013-11-26 00:02:05' +004 | dvce_created_tstamp | timestamp | Date / time fields | Timestamp for the event recorded on the client device | No | '2013-11-26 00:03:57.885' +005 | dvce_sent_tstamp | timestamp | Date / time fields | When the event was actually sent by the client device | No | '2013-11-26 00:03:58.032' +006 | etl_tstamp | timestamp | Date / time fields | Timestamp for when the event was validated and enriched. Note: the name is historical and does not mean that the event is loaded at this point (this is further downstream). | No | '2017-01-26 00:01:25.292' +007 | os_timezone | text | Date / time fields | Client operating system timezone | No | 'Europe/London' +008 | derived_tstamp | timestamp | Date / time fields | Timestamp making allowance for inaccurate device clock | No | '2013-11-26 00:02:04' +009 | true_tstamp | timestamp | Date / time fields | User-set "true timestamp" for the event | No | '2013-11-26 00:02:04' +010 | load_tstamp | timestamp | Date / time fields | Timestamp for when the data was loaded into the warehouse, best choice for incremental processing | No | '2013-11-26 00:02:04' +011 | event | text | Event / transaction fields | The type of event recorded | Yes | 'page_view' +012 | event_id | text | Event / transaction fields | A UUID for each event | Yes | 'c6ef3124-b53a-4b13-a233-0088f79dcbcb' +013 | txn_id | int | Event / transaction fields | Transaction ID set client-side, used to de-dupe records | No | 421828 +014 | event_fingerprint | text | Event / transaction fields | Hash client-set event fields, used to de-dupe records | No | AADCE520E20C2899F4CED228A79A3083 +015 | v_tracker | text | Snowplow version fields | Tracker version | Yes | 'js-3.0.0' +016 | v_collector | text | Snowplow version fields | Collector version | Yes | 'ssc-2.1.0-kinesis' +017 | v_etl | text | Snowplow version fields | ETL version | Yes | 'snowplow-micro-1.1.0-common-1.4.2' +018 | name_tracker | text | Snowplow version fields | Tracker namespace | No | 'sp1' +019 | user_id | text | User-related fields | Unique ID set by business | No | 'c94f860b-1266-4dad-ae57-3a36a414a521' +020 | domain_userid | text | User-related fields | User ID set by Snowplow using 1st party client-set cookie | No | '4b0dfa75-9a8c-46a1-9691-01add9db4200' +021 | network_userid | text | User-related fields | User ID set by Snowplow using server-set cookie, which may be 1st or 3rd party, depending on collector configuration. | No | 'ecdff4d0-9175-40ac-a8bb-325c49733607' +022 | user_ipaddress | text | User-related fields | User IP address, can be overwritten with the IP Anonymization Enrichment | No | '92.231.54.234' +023 | domain_sessionidx | int | User-related fields | A visit / session index | No | 3 +024 | domain_sessionid | text | User-related fields | A visit / session identifier | No | 'c6ef3124-b53a-4b13-a233-0088f79dcbcb' +025 | useragent | text | Device and operating system fields | Raw useragent | No | +026 | dvce_type | text | Device and operating system fields | Type of device | No | 'Computer' +027 | dvce_ismobile | boolean | Device and operating system fields | Is the device mobile? | No | 1 +028 | dvce_screenheight | int | Device and operating system fields | Screen height in pixels | No | 1024 +029 | dvce_screenwidth | int | Device and operating system fields | Screen width in pixels | No | 1900 +030 | os_name | text | Device and operating system fields | Name of operating system | No | 'Android' +031 | os_family | text | Device and operating system fields | Operating system family | No | 'Linux' +032 | os_manufacturer | text | Device and operating system fields | Company responsible for OS | No | 'Apple' +033 | geo_country | text | Location fields | ISO 3166-1 code for the country the visitor is located in | No | 'GB', 'US' +034 | geo_region | text | Location fields | ISO-3166-2 code for country region the visitor is in | No | 'I9', 'TX' +035 | geo_city | text | Location fields | City the visitor is in | No | 'New York', 'London' +036 | geo_zipcode | text | Location fields | Postcode the visitor is in | No | '94109' +037 | geo_latitude | text | Location fields | Visitor location latitude | No | 37.443604 +038 | geo_longitude | text | Location fields | Visitor location longitude | No | -122.4124 +039 | geo_region_name | text | Location fields | Visitor region name | No | 'Florida' +040 | geo_timezone | text | Location fields | Visitor timezone name | No | 'Europe/London' +041 | ip_isp | text | IP address-based fields | Visitor's ISP | No | 'FDN Communications' +042 | ip_organization | text | IP address-based fields | Organization associated with the visitor's IP address - defaults to ISP name if none is found | No | 'Bouygues Telecom' +043 | ip_domain | text | IP address-based fields | Second level domain name associated with the visitor's IP address | No | 'nuvox.net' +044 | ip_netspeed | text | IP address-based fields | Visitor's connection type | No | 'Cable/DSL' +045 | event_vendor | text | Metadata fields | Who defined the event | Yes | 'com.acme' +046 | event_name | text | Metadata fields | Event name | Yes | 'link_click' +047 | event_format | text | Metadata fields | Format for event | Yes | 'jsonschema' +048 | event_version | text | Metadata fields | Version of event schema | Yes | '1-0-2' +049 | mkt_medium | text | Marketing / traffic source fields | Type of traffic source | No | 'cpc', 'affiliate', 'organic', 'social' +050 | mkt_source | text | Marketing / traffic source fields | The company / website where the traffic came from | No | 'Google', 'Facebook' +051 | mkt_term | text | Marketing / traffic source fields | Any keywords associated with the referrer | No | 'new age tarot decks' +052 | mkt_content | text | Marketing / traffic source fields | The content of the ad. (Or an ID so that it can be looked up.) | No | 13894723 +053 | mkt_campaign | text | Marketing / traffic source fields | The campaign ID | No | 'diageo-123' +054 | mkt_clickid | text | Marketing / traffic source fields | The click ID | No | 'ac3d8e459' +055 | mkt_network | text | Marketing / traffic source fields | The ad network to which the click ID belongs | No | 'DoubleClick' +056 | page_url | text | Platform > Web > Page | The page URL | No | 'http://www.example.com' +057 | page_urlscheme | text | Platform > Web > Page | Scheme aka protocol | No | 'https' +058 | page_urlhost | text | Platform > Web > Page | Host aka domain | No | '“www.snowplowanalytics.com' +059 | page_urlport | int | Platform > Web > Page | Port if specified, scheme dependent if not (443 for https, 80 for http) | No | 80 +060 | page_urlpath | text | Platform > Web > Page | Path to page | No | '/product/index.html' +061 | page_urlquery | text | Platform > Web > Page | Querystring | No | 'id=GTM-DLRG' +062 | page_urlfragment | text | Platform > Web > Page | Fragment aka anchor | No | '4-conclusion' +063 | page_referrer | text | Platform > Web > Page | URL of the referrer | No | 'http://www.referrer.com' +064 | page_title | text | Platform > Web > Page | Web page title | No | 'Snowplow Docs - Understanding the structure of Snowplow data' +065 | refr_urlscheme | text | Platform > Web > Page | Referrer scheme | No | 'http' +066 | refr_urlhost | text | Platform > Web > Page | Referrer host | No | 'www.bing.com' +067 | refr_urlport | int | Platform > Web > Page | Referrer port | No | 80 +068 | refr_urlpath | text | Platform > Web > Page | Referrer page path | No | '/images/search' +069 | refr_urlquery | text | Platform > Web > Page | Referrer URL querystring | No | 'q=psychic+oracle+cards' +070 | refr_urlfragment | text | Platform > Web > Page | Referrer URL fragment | No | +071 | refr_medium | text | Platform > Web > Page | Type of referrer | No | 'search', 'internal' +072 | refr_source | text | Platform > Web > Page | Name of referrer if recognized | No | 'Bing images' +073 | refr_term | text | Platform > Web > Page | Keywords if source is a search engine | No | 'psychic oracle cards' +074 | refr_domain_userid | text | Platform > Web > Page | The Snowplow domain_userid of the referring website | No | 'bc2e92ec6c204a14' +075 | refr_dvce_tstamp | timestamp | Platform > Web > Page | The time of attaching the domain_userid to the inbound link | No | '2013-11-26 00:02:05' +076 | doc_charset | text | Platform > Web > Document | The page’s character encoding | No | , 'UTF-8' +077 | doc_width | int | Platform > Web > Document | The page's width in pixels | No | 1024 +078 | doc_height | int | Platform > Web > Document | The page's height in pixels | No | 3000 +079 | user_fingerprint | int | Platform > Web > Browser | A user fingerprint generated by looking at the individual browser features | No | 2161814971 +080 | br_name | text | Platform > Web > Browser | Browser name | No | 'Firefox 12' +081 | br_version | text | Platform > Web > Browser | Browser version | No | '12.0' +082 | br_family | text | Platform > Web > Browser | Browser family | No | 'Firefox' +083 | br_type | text | Platform > Web > Browser | Browser type | No | 'Browser' +084 | br_renderengine | text | Platform > Web > Browser | Browser rendering engine | No | 'GECKO' +085 | br_lang | text | Platform > Web > Browser | Language the browser is set to | No | 'en-GB' +086 | br_features_pdf | boolean | Platform > Web > Browser | Whether the browser recognizes PDFs | No | 1 +087 | br_features_flash | boolean | Platform > Web > Browser | Whether Flash is installed | No | 1 +088 | br_features_java | boolean | Platform > Web > Browser | Whether Java is installed | No | 1 +089 | br_features_director | boolean | Platform > Web > Browser | Whether Adobe Shockwave is installed | No | 1 +090 | br_features_quicktime | boolean | Platform > Web > Browser | Whether QuickTime is installed | No | 1 +091 | br_features_realplayer | boolean | Platform > Web > Browser | Whether RealPlayer is installed | No | 1 +092 | br_features_windowsmedia | boolean | Platform > Web > Browser | Whether mplayer2 is installed | No | 1 +093 | br_features_gears | boolean | Platform > Web > Browser | Whether Google Gears is installed | No | 1 +094 | br_features_silverlight | boolean | Platform > Web > Browser | Whether Microsoft Silverlight is installed | No | 1 +095 | br_cookies | boolean | Platform > Web > Browser | Whether cookies are enabled | No | 1 +096 | br_colordepth | int | Platform > Web > Browser | Bit depth of the browser color palette | No | 24 +097 | br_viewheight | int | Platform > Web > Browser | Viewport height | No | 1000 +098 | br_viewwidth | int | Platform > Web > Browser | Viewport width | No | 1000 +099 | pp_xoffset_min | integer | Event-specific > Page Pings | Minimum page x offset seen in the last ping period | No | 10 +100 | pp_xoffset_max | integer | Event-specific > Page Pings | Maximum page x offset seen in the last ping period | No | 100 +101 | pp_yoffset_min | integer | Event-specific > Page Pings | Minimum page y offset seen in the last ping period | No | 5 +102 | pp_yoffset_max | integer | Event-specific > Page Pings | Maximum page y offset seen in the last ping period | No | 200 +103 | tr_orderid | text | Event-specific > E-Commerce | Order ID | Yes | '#134' +104 | tr_affiliation | text | Event-specific > E-Commerce | Transaction affiliation (e.g. store where sale took place) | No | 'web' +105 | tr_total | decimal | Event-specific > E-Commerce | Total transaction value | Yes | 12.99 +106 | tr_tax | decimal | Event-specific > E-Commerce | Total tax included in transaction value | No | 3.00 +107 | tr_shipping | decimal | Event-specific > E-Commerce | Delivery cost charged | No | 0.00 +108 | tr_total_base | decimal | Event-specific > E-Commerce | Total in base currency | No | 12.99 +109 | tr_tax_base | decimal | Event-specific > E-Commerce | Total tax in base currency | No | 3.00 +110 | tr_shipping_base | decimal | Event-specific > E-Commerce | Delivery cost in base currency | No | 0.00 +111 | tr_city | text | Event-specific > E-Commerce | Delivery address, city | No | 'London' +112 | tr_state | text | Event-specific > E-Commerce | Delivery address, state | No | 'Washington' +113 | tr_country | text | Event-specific > E-Commerce | Delivery address, country | No | 'France' +114 | tr_currency | text | Event-specific > E-Commerce | Currency | No | 'USD' +115 | ti_orderid | text | Event-specific > E-Commerce | Order ID | Yes | '#134' +116 | ti_sku | text | Event-specific > E-Commerce | Product SKU | Yes | 'pbz00123' +117 | ti_name | text | Event-specific > E-Commerce | Product name | No | 'Cone pendulum' +118 | ti_category | text | Event-specific > E-Commerce | Product category | No | 'New Age' +119 | ti_price | decimal | Event-specific > E-Commerce | Product unit price | Yes | 9.99 +120 | ti_price_base* | decimal | Event-specific > E-Commerce | Price in base currency | No | 9.99 +121 | ti_quantity | integer | Event-specific > E-Commerce | Number of product in transaction | Yes | 2 +122 | ti_currency | text | Event-specific > E-Commerce | Currency | No | 'EUR' +123 | base_currency* | text | Event-specific > E-Commerce | Reporting currency | No | 'GBP' +124 | se_category | text | Structured events | Category of event | Yes* | 'ecomm', 'video' +125 | se_action | text | Structured events | Action performed / event name | Yes* | 'add-to-basket', 'play-video' +126 | se_label | text | Structured events | The object of the action e.g. the ID of the video played or SKU of the product added-to-basket | No | 'pbz00123' +127 | se_property | text | Structured events | A property associated with the object of the action | No | 'HD', 'large' +128 | se_value | decimal | Structured events | A value associated with the event / action e.g. the value of goods added-to-basket | No | 9.99