Pages

3 Objects and Methods

Tracking Objects

Mapp Intelligence provides four distinct tracking objects, each intended for a specific purpose. The main object, data, includes the entire tracking configuration, while parameter, category, and goal allow selective updates.

• data

  Contains all tracking information. Use this object to initialize tracking or update multiple tracking values at once.

• parameter

  Stores custom tracking attributes (e.g., A/B-test variants or error codes). Use this object to update or set custom values independently, without affecting other page properties.

• category

  Assigns pages to structured content groups. Use this object to update content group assignments individually.

• goal – Tracking User Actions

  Tracks key actions or conversions (e.g., newsletter sign-ups or purchases). Use this object when you need to track a specific goal independently from other page data.

Supported Methods

Each of the objects above supports the following four methods:

3.1 data – Full Page Configuration

The data object includes all page-tracking information, combining page attributes (name, search) and the nested objects parameter, category, and goal.

/**
 * @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);

/**
 * @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);

/**
 * @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();

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

Example

The following example demonstrates how these methods are combined in practice:

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']);
});

3.2 parameter – Custom Page Values

The parameter object stores custom values assigned to a page.

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

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

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

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

Example

The following example demonstrates how these methods are combined in practice:

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]);
});

3.3 category – Page Classification

The category object assigns a page to content groups.

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

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

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

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

Example

The following example demonstrates how these methods are combined in practice:

// 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]);

3.4 goal – Tracking User Actions

The goal object is used to track specific actions completed by users on a page.

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

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

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

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

Example

The following example demonstrates how these methods are combined in practice:

// 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]);

4 Code Generator

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