page

On this page you find all information that you can send for a page.

Properties

Here is an overview of all supported properties:

Page naming

By default, the pixel creates a name on the basis of the page URL. Parameters and hash in the URL are not automatically taken into account for the page name. See chapter advanced to include URL parameter(s) and hash.

For example, the URL "http://www.website.com/product_abc.htm?sid=7af49" will be automatically changed to form the page name "www.website.com/produkt_abc.htm".

If you want to manually create a page name, simply fill the value for "name" with your desired page name. When left blank the pixel creates the page name automatically.

Category (Content groups)

Page-related categories are called content groups. They must be configured in the Mapp tool before being able to track them via the pixel. When configuring the tracking in the pixel, you need to include the ID as a number and the respective value as a string.

Content group parameters should not exceed a length of 255 characters. All additional characters will be deleted.

Content groups are assigned one time to a page. If a page is tracked together with a content group, all subsequent page calls of the page will also be assigned to this content group. Only the first-ever tracked value will be shown.

We, therefore, recommend implementing content IDs and content groups while embedding the pixel.

See also How can I replace missing values ("-") in categories?

Parameter

Page parameters refer to single pages and are assigned to them directly. In contrast to content groups, parameters can be used to pass different values with each page request.

Page parameters must be configured in the Mapp tool before being able to track them via the pixel. When configuring the tracking in the pixel, you need to include the ID as a number and the respective value as a string.

Goal

Website goals help to track the success of your website. You can easily analyze and filter the individual goals in the Mapp Intelligence tool.

Furthermore, the calculation of the customer journey is based on website goals, meaning that you can track the individual campaigns responsible for the goal achievement.

Website goals have to be configured.  When configuring the tracking in the pixel, you need to include the ID as a number and the respective value as a string.

The website goal "Order" is predefined in Mapp Intelligence and cannot be tracked within the page object.

As soon as a parameter is tracked (no matter which value is submitted), the goal is set as achieved. Therefore it does not make sense to submit the value "no" for the goal "Newsletter Registration" if a user has not registered for the newsletter. Setting the value to "no" would instead mark the goal as achieved.

Methods

The page object contains the following four methods that are contained in the objects data, parameter, category, and goal:

data

set

/**
 * @param {{
 *		[name="default page name"]: string,
 *      [search=""]: string,
 *      [numberSearchResults=0]: number,
 *      [errorMessages=""]: string,
 *      [paywall=false]: boolean,
 *      [articleTitle=""]: string,
 *      [contentTags=""]: string,
 *      [title=""]: string,
 *      [type=""]: string,
 *      [length=""]: string,
 *      [daysSincePublication=0]: number,
 *      [testVariant=""]: string,
 *      [testExperiment=""]: string,
 *      [parameter={}]: {[number]: string},
 *      [category={}]: {[number]: string},
 *      [goal={}]: {[number]: string}
 * }} data
 *
 * @returns {wtSmart.page.data}
 */
wtSmart.page.data.set(data);

add

/**
 * @param {{
 *		[name]: string,
 *      [search]: string,
 *      [numberSearchResults]: number,
 *      [errorMessages]: string,
 *      [paywall]: boolean,
 *      [articleTitle]: string,
 *      [contentTags]: string,
 *      [title]: string,
 *      [type]: string,
 *      [length]: string,
 *      [daysSincePublication]: number,
 *      [testVariant]: string,
 *      [testExperiment]: string,
 *      [parameter]: {[number]: string},
 *      [category]: {[number]: string},
 *      [goal]: {[number]: string}
 * }} data
 *
 * @returns {wtSmart.page.data}
 */
wtSmart.page.data.add(data);

get

/**
 * @returns {{
 *	    name: string,
 *      search: string,
 *      numberSearchResults: number,
 *      errorMessages: string,
 *      paywall: boolean,
 *      articleTitle: string,
 *      contentTags: string,
 *      title: string,
 *      type: string,
 *      length: string,
 *      daysSincePublication: number,
 *      testVariant: string,
 *      testExperiment: string,
 *      parameter: {[number]: string},
 *      category: {[number]: string},
 *      goal: {[number]: string}
 * }}
 */
wtSmart.page.data.get();

remove

/**
 * @param {string[]} [removeList]
 *
 * @returns {wtSmart.page.data}
 */
wtSmart.page.data.remove(removeList);

Example

window.wtSmart = window.wtSmart || [];
window.wtSmart.push(function(wtSmart) {
	// set page data
	wtSmart.page.data.set({
		name: 'en.index.home',
		search: 'search term',
		numberSearchResults: 7,
		errorMessages: 'error: ...',
		paywall: false,
		articleTitle: 'article title',
		contentTags: 'content tags',
		title: 'page title',
		type: 'page type',
		length: 'medium',
		daysSincePublication: 5,
		testVariant: 'test variant',
		testExperiment: 'test experiment',
		parameter: {
			5: 'parameter value 5'
		},
		category: {
			8: 'category value 8'
		},
		goal: {
			2: 'goal value 2'
		}
	});

	// add page data
	wtSmart.page.data.add({
		paywall: true,
		category: {
			5: 'category value 5'
		}
	});

	// get page data
	var data = wtSmart.page.data.get();
	 
	// remove all page data
	wtSmart.page.data.remove();

	// remove only testVariant and testExperiment from page data
	wtSmart.page.data.remove(['testVariant', 'testExperiment']);
});

parameter

set

/**
 * @param {{[number]: string}} data
 * 
 * @returns {wtSmart.page.parameter}
 */
wtSmart.page.parameter.set(data);

add

/**
 * @param {{[number]: string}} data
 * 
 * @returns {wtSmart.page.parameter}
 */
wtSmart.page.parameter.add(data);

get

/**
 * @returns {{[number]: string}}
 */
wtSmart.page.parameter.get();

remove

/**
 * @param {number[]} [removeList]
 *
 * @returns {wtSmart.page.parameter}
 */
wtSmart.page.parameter.remove(removeList);

Example

window.wtSmart = window.wtSmart || [];
window.wtSmart.push(function(wtSmart) {
	// set page parameter
	wtSmart.page.parameter.set({
		5: 'parameter value 5'
	});

	// add page parameter
	wtSmart.page.parameter.add({
		8: 'parameter value 8'
	});

	// get page parameter
	var parameter = wtSmart.page.parameter.get();

	// remove all page parameter
	wtSmart.page.parameter.remove();

	// remove only page parameter 5
	wtSmart.page.parameter.remove([5]);
});

category

set

/**
 * @param {{[number]: string}} data
 * 
 * @returns {wtSmart.page.category}
 */
wtSmart.page.category.set(data);

add

/**
 * @param {{[number]: string}} data
 * 
 * @returns {wtSmart.page.category}
 */
wtSmart.page.category.add(data);

get

/**
 * @returns {{[number]: string}}
 */
wtSmart.page.category.get();

remove

/**
 * @param {number[]} [removeList]
 *
 * @returns {wtSmart.page.category}
 */
wtSmart.page.category.remove(removeList);

Example

// set page category
wtSmart.page.category.set({
	5: 'category value 5'
});

// add page category
wtSmart.page.category.add({
	8: 'category value 8'
});

// get page category
var category = wtSmart.page.category.get();

// remove all page category
wtSmart.page.category.remove();

// remove only page category 8
wtSmart.page.category.remove([8]);

goal

set

/**
 * @param {{[number]: string}} data
 * 
 * @returns {wtSmart.page.goal}
 */
wtSmart.page.goal.set(data);

add

/**
 * @param {{[number]: string}} data
 * 
 * @returns {wtSmart.page.goal}
 */
wtSmart.page.goal.add(data);

get

/**
 * @returns {{[number]: string}}
 */
wtSmart.page.goal.get();

remove

/**
 * @param {number[]} [removeList]
 *
 * @returns {wtSmart.page.goal}
 */
wtSmart.page.goal.remove(removeList);

Example

// set page goal
wtSmart.page.goal.set({
	5: 'goal value 5'
});

// add page goal
wtSmart.page.goal.add({
	8: 'goal value 8'
});

// get page goal
var goal = wtSmart.page.goal.get();

// remove all page goals
wtSmart.page.goal.remove();

// remove only page goal 8
wtSmart.page.goal.remove([8]);

Code Generator

Use the code generator to create individual code that you can then integrate directly into the website.