• Expand/CollapseMenu
Help

Webtrekk Tag Setup Guide

This article describes how to set up the Webtrekk tag in your Tealium iQ Tag Management (TiQ) profile.

In this article:

Table of Contents Placeholder

Prerequisites

  • Webtrekk account

Supported Versions

  • v5.5.1 (recommended)
  • v4.4.7
  • v4.4.4

Tag Configuration

First, go to Tealium tag marketplace and add the Webtrekk tag to your profile (how to add a Tag?).

After adding the tag, configure the following settings:

  • Title
    • The default is "Webtrekk".
    • You may replace it with a descriptive name of choice.
  • Library Version
    • Choose the version of your Webtrekk pixel (i.e. tracking script) from this list.
  • Track ID
    • Enter the numeric track ID you received from Webtrekk.
    • Track ID can be located in the Webtrekk tool, under System Configuration > Data Collection.
  • Track Domain
    • Enter the tracking URL (excluding the https/http protocol), as specified in your Webtrekk pixel, such as track.XXXX.net
  • TagIntegration Customer ID
    • Enter your SafeTag identifier.
    • This is defined in the safetag object and required if you are loading the TagIntegration file from a Webtrekk server.
  • TagIntegration Domain
    • Enter the SafeTag domain.
    • Required if you are loading the TagIntegration file from a Webtrekk server.
  • Param First
    • Enter the the list of parameters in the order you want them passed in the request.
    • Separate the parameters with semi-colon (;).
  • Site Domain
    • Optional.
    • Enter the domain of the site being tracked.
  • Link Tracking
    • Select one of the following preferred settings for tracking visitor actions/events, clicks, downloads, etc.
      • Link (default)
        • Sends the value of href attribute, such as the destination page URL in the clicked link, as the action/event name.
        • For example, if the clicked link is <a href="example.htm">Click here</a>, the value example.htm is passed.
      • Standard
        • Sends the value of the name attribute as the action/event name.
        • For example, if the clicked link is <a href="example.htm" name="example_name">Click here</a>, the value example_name is passed.
      • None
        • Disables link/event tracking for the tag instance.
  • Link Track Attribute
    • Optional configuration for Standard tracking option.
    • Enter the HTML attribute that you want to use instead of the default name attribute for assigning the action/event name.
    • For example, in this link <a href="example.htm" name="internal_id" rel="example">Click here</a>, you may use rel instead of name.
  • Link Track Params
    • Optional.
    • Configuration for Link tracking option.
    • Enter the name of the querystring parameter with which to track the clicked link.
    • Use commas to separate multiple parameters.
    • For example: <a href="example.htm?page=10">Go to page 10</a>
  • Link Track Downloads
    • Enter the list of file types you wish to track for downloads.
    • Use semi-colons to separate multiple entries.
    • For example: zip;raw;doc
  • Pixel Sampling:
    • Allows you to control the percentage of traffic that is reported to Webtrekk.
    • Enter a numeric value.
  • Force HTTPS:
    • Choose whether or not to force send a request as secure.
    • Default setting is OFF.
  • Cookie Handling
    • Choose the type of cookie you prefer to use for tracking visitors on your site.
      • First party
        • Default
        • Recommended)
        • Cookie value set by your site domain
      • Third party
        • Cookie value set by Webtrekk.
  • Cookie Domain
    • Applies to first party cookies only.
    • If your top level domain is double-barrelled (suffixed by an additional identifier such as .co, .uk, etc.), you must specify it here in order for the cookies to be set correctly.
  • mediaCode
    • Enter the media code parameter with which to identify and track your campaign.
  • mediaCodeCookie
    • Enter the media code cookie parameter with which to track a campaign only once per session.
    • If the mediaCode query parameter is in the address bar, set the value to sid.
  • WT Object Name
    • Pre-populated by wt which is the default object for a single tag instance.
    • If you are loading multiple tag instances on the same page, replace with a unique object name in each of those tags.
  • Heat Map tracking
    • Choose whether or not you want to activate Heatmap tracking for this tag instance.
    • Default setting is OFF.
  • Form tracking
    • Choose whether or not you want to activate Form tracking for this tag instance.
    • Default setting is OFF.

Load Rules

Load Rules determine when and where to load an instance of this tag on your site. The 'Load on All Pages' rule is the default Load Rule. To load this tag on a specific page, create relevant Rule conditions to apply to the tag.

Recommended Rule: All Pages (default)

Data Mappings

Mapping is the process of sending data from a Data Layer Variable to the corresponding destination variable of the vendor tag. For instructions on how to map a Variable to a tag destination, see Data Mappings.

Standard Category

Map to these destinations to either override or dynamically populate the tag settings.

These mappings apply to your global  Webtrekk.js configuration.

Tag Destination Description
WT object name
  • Object name for uniquely identifying the tag instance.
  • Default value is wt.
Cookie OptOut Name
  • Name of the webtrekkOptOut cookie
Cookie OptOut Time Frame
  • Lifespan of the webtrekkoptout cookie
Parameters to Include First
  • List of parameters separated by semi-colon.
  • Parameters are sent in the order listed in the variable.
Ignore Pre-rendering
  • Flag (Boolean value) to determine whether or not to track pre-rendered pages
Form Path Analysis
  • Flag (Boolean value) to enable or disable form field tracking 
tabBrowsing
  • Flag (Boolean value) for tracking browser tab views.
  • Default value is false 
globalVisitorIds  
execRTA
  • Flag (Boolean value) for enabling or disabling Webtrekk’s Real Time Bidding (RTB) service
execCDB
  • Flag (Boolean value) for enabling or disabling Webtrekk’s Cross Device Bridge (CDB) technology
useCDBCache
  • Flag (Boolean value) for enabling or disabling the use of image cache cookie
useCDBScript  
requestLimitAmount
  • The maximum number of requests that can be sent
requestLimitTime
  • The permissible time limit for sending the maximum number of requests 
Track ID
  • Numeric identifier of the tracking pixel you received from Webtrekk.
  • Track ID can also be found in the Webtrekk tool, under System Configuration >  Data Collection.
Track Domain
  • Tracking URL, excluding https/http protocol), as specified in your Webtrekk pixel.
Site Domain
  • Domain of the site being tracked.
Link Tracking
  • Event tracking settings for tracking visitor actions, clicks, and downloads.
  • Webtrekk supports two options: Link and Standard.
Link Track Attribute
  • Applies to "Standard" tracking option.
  • This attribute is used for determining the name of the event/action.
  • Mapping to this destination overrides the default "name".
Link Track Params
  • Applies to "Link" tracking option in the global configuration.
  • Mapping to this destination sends the query string parameter with which to track the clicked link.
Link Track Pattern
  • Regular Expression for filtering undesirable parameter(s) out of the Link Track Parameter query string.
Link Track Replace
  • Replacement character with which to replace the filtered parameters in the Link Track Parameter.
Link Track Ignore Pattern
  • Regular Expression to exclude individual links from being tracked
No Delay Link Track Attribute
  • Disables delaying of links that are explicitly tagged with this parameter
Link Track Downloads
  • List of file types that you want to track for downloads in the global configuration.
  • For example: zip;raw;doc
Pixel Sampling
  • Percentage of traffic reported to Webtrekk.
Force HTTPS
  • Force send a request as secure.
  • Data source must contain the value 1 for activation and 0 for deactivation.
Cookie Handling
  • Either first or third party cookie for tracking visitors on your site.
  • First party is default and recommended.
Cookie Domain
  • Applies to firstparty cookies only.
  • Map to this destination if your top level domain is double barrelled, i.e. it is suffixed by an additional identifier such as .co, .uk, etc.
contentId
  • Identifies a page by its unique name rather than its URL.
Heat map
  • Activate/deactivate Heatmap in the global configuration.
  • Data source value must equal 1 for activation and 0 for deactivation.
Form
  • Activate/deactivate Form tracking in the global configuration.
  • Data source value must equal 1 for activation and 0 for deactivation.
executePluginFuntion
  • List of Plugin functions
Media Code
  • Parameter for tracking campaigns.
Media Code cookie
  • Parameter for tracking a campaign ONLY once per session.
SafeTag Async
  • Flag (Boolean value) to determine whether or not to load the tag asynchronously
SafeTag Timeout
  • The maximum amount of time to wait for the TagIntegration file to load. 
SafeTag Domain
  • TagIntegration domain
SafeTag Customer ID
  • TagIntegration customer identifier
SafeTag Custom Domain
  • Custom domain from where the TagIntegration file should load
SafeTag CustomPath
  • Path of the JavaScript file, for custom domain
SafeTag Option [Object]
  • Additional TagIntegration information
SafeTag Option  
Custom wt config item  

General Category

Map to these destinations for reporting custom/optional parameters such as Visitor IDs, Session, and Categories.

Tag Destination Description
Custom Visitor ID
  • Map to this destination for sending unique visitor identifier.
URM categories
  • URM Categories in your Webtrekk tool
Email RID
  • Email recipient ID
Email Opt-In
  • Email Opt In status.
  • Possible values:
    • 1 (yes)
    • 2 (no)
    • 3 (unknown)
Gender
  • Gender
  • Possible values:
    • 1 (male)
    • 2 (female)
    • 3 (unknown) 
Birthday
  • Date of birth (YYYYMMDD)
Birthday Year
  • Year of birth (YYYY)
Birthday Month
  • Month of birth (MM)
Birthday Day
  • Date of birthday (DD)
CRM Category 1 to 10
  • Custom categories for sending CRM information such as membership type, age, and gender.
  • Before mapping, make sure the category is defined in your Webtrekk tool.
Custom Session Parameter 1 to 10
  • Custom parameters for sending additional visit/session information such as login status, registration status, and test group for A/B testing.
  • Before mapping, make sure the session parameter is defined in your Webtrekk tool.

Page Data Category

Tag Destination Description
Page Content ID
  • Identifies a page by its unique name rather than its URL and is set in the page-specific configuration.
Content Group 1 to 25
  • Map to these destinations to send up to 50 custom parameters for a page.
  • Make sure the Content Group you are mapping to is also defined in your Webtrekk tool.
Custom Parameter 1 to 50
  • Map to these destinations to send up to 50 custom parameters for a page.

Search and Form Tracking

Map to these destinations for sending internal search and form input parameters.

Tag Destination Description
Internal Search
  • Search keywords/terms used by visitors to look up your site
Form Tracking
  • Activate/deactivate Form tracking in the page-specific configuration
  • Data source must contain the value 1 for activation and 0 for deactivation.
Form Attribute
  • This attribute is used for determining the name of the form.
  • Mapping to this destination overrides the default "name" attribute.
Form Value Attribute
  • This attribute is used for determining the name of the form when the form field is a 'radio' or a 'checkbox'.
  • Mapping to this destination overrides the default  value attribute.
Form Field Attribute ---
Full Content Form Tracking Sends the first 30 characters of a free-text field.
Anonymous Form Tracking
  • Contents of the form will not be sent to Webtrekk.
  • Mapping to this destination makes the form data anonymous.
Form HTML Id
  • Method from tracking forms reloaded by Ajax.
  • Mapping to this destination invokes the method

Click Tracking

Tag Destination Description
Heatmap
  • Activate/deactivate Heatmap in the page-specific configuration.
  • Data source value must equal 1 for activation and 0 for deactivation.
Heatmap reference point id
  • ID of the element being used as a point of reference for Heatmaps.
Link Track
  • Event tracking settings in the page-specific configuration.
  • Webtrekk supports 'Link' and 'Standard' settings.
Link Track Attribute
  • Applies to "Standard" tracking option in the page-specific configuration.
  • This attribute is used for determining the name of the event/action.
  • Mapping to this destination overrides the default "name".
Link Tracks Params
  • Applies to "Link" tracking option in the page-specific configuration.
  • Mapping to this destination sends the query string parameter of the tracked link.
Link Track Pattern
  • Regular Expression for filtering undesirable parameter(s) out of the Link Track Parameter query string.
  • Applies to page-specific configuration.
Link Track Replace
  • Replacement character for replacing the filtered parameters in the Link Track Parameter.
  • Applies to page-specific configuration.
Link Track Downloads
  • List of file types that you want to track for downloads.
  • Applies to page-specific configuration.
  • Example: zip;raw;doc
Link ID for custom utag.link tracking
  • Name of the tracked link.
Custom Click parameter 1 to 10
  • Custom parameters for click tracking.
  • The Link ID value must be mapped in order for your custom click parameter(s) to be sent.
  • Before mapping, make sure the parameter is also defined in your Webtrekk tool.

Campaign Tracking

Map to these destinations for sending optional and custom campaign parameters

These mappings apply to page-specific configurations.

Tag Destination Description
Media Code
  • Parameter for tracking campaigns.
Media Code Cookie
  • Parameter for tracking a campaign ONLY once per session.
Campaign ID
  • Media code parameter followed by %3D and the parameter value
Campaign Action
  • Determines whether the visitor's response to a campaign was 'view' or 'click'.
Custom Campaign Parameters 1 to 10
  • Custom parameters for campaign tracking.
  • Before mapping, make sure the parameter is defined in your Webtrekk tool.

E-Commerce Category

Since the Webtrekk tag is e-commerce enabled, it will automatically use the default E-Commerce Extension mappings. Manually mapping in this category is generally not needed unless:

  • you want to override any Extension mappings
  • your desired e-commerce variable is not offered in the Extension
Tag Destination Description E-Commerce Extension Mappings 
Order ID
  • Unique identifier of the final order
  _corder
Order Total
  • Total amount after shipping and tax.
  _ctotal
Currency
  • Currency used by the customer to make the payment
  _ccurrency
Coupon Value
  • The value of the coupon used in the order
 N//A
List of product names
  • Name of each product in the product array
  _cprodname
List of product quantities
  • Quantity of each product in the product array
  _cquan
List of product prices
  • Unit price of each product in the product array
  _cprice
List of product categories (productCategories[1])
  • Category of each product in the product array
  _ccat
List of product brands (productCategory[2])
  • Brand of each product in the product array
  _cbrand
List of product subcategories (productCategory[3])
  • Sub-category of each product in the product array
  _ccat2
Product Status
  • Indicates if the product was viewed, added to cart, or checked out from the cart.
 N/A
Product Category 1 to 25
  • Custom category with which a product can be associated only once.
  • You may map up to 25 unique categories.
  • Before mapping, make sure the product category is defined in your Webtrekk tool.
 N/A
Custom E-Commerce Parameter 1 to 50
  • Custom parameters for sending additional product- and order-level data.
  • You may map up to 50 unique parameters.
  • Before mapping, make sure the parameter(s) is defined in your Webtrekk tool.
 N/A
Version history
Last update:
‎12-03-2019 01:15 PM
Updated by:

Copyright All Rights Reserved © 2008-2021