Set Custom Variable Macro

Section

Column

Document Properties Marker

extract-short-desc	true
render-as	definition-list

Short Description

Provide a single custom variable to the Piwik context.

Doctype

macro

hide

Name

Set One Custom Variable

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience

Subject

Name List

doctype	subject
property	Subject

Tags

Tag List

Iteration


value	filled

hide

Sort Key

hide

Column

Section

index	true
title	Description

This macro makes it easy for Confluence users to set custom variables for Piwik.

Quote External

source-uri	http://piwik.org/docs/custom-variables/
author	Piwik
source	Custom Variables Analytics

A custom variable is a custom name-value pair that you can assign to your visitors (or page views) using the JavaScript Tracking API, and then visualize the reports of how many visits, conversions, etc. for each custom variable.

Section

title	Properties

Here is an overview over the options for this macro:

Section

level	2
title	Name

Specify the mandatory name of the custom variable you want to set.

This name will appear in your Piwik report. When you are logged in in Piwik Select Visitors -> Custom Variables. The name appears top level.

Example Box

title	Screenshot showing the Name of a Custom Variable

Here is a screenshot for a custom variable named 'Category'.

The length is limited to 200 characters. Keep the value as short as possible to save resources and to not exceed the maximum URL length supported by your web server.

Section

level	2
title	Value

Specify the mandatory value to be associated with the name of the custom variable.

This value will appear in your Piwik report. When you are logged in in Piwik, select Visitors -> Custom Variables. The value appears below the name the value is bound to.

Example Box

title	Screenshot showing the Name and Value of a Custom Variable

Here is a screenshot for a custom variable named 'Category' with the value of 'blog-projectdoc-101'.

The length is limited to 200 characters. Keep the value as short as possible to save resources and to not exceed the maximum URL length supported by your web server.

Section

level	2
title	Scope

Define how the information provided by the custom variable is stored.

You have two options:

Definition List

visit	the custom variable is only valid in the current session.
page	use to determine how your landing pages perform.

For detailed information, please refer to Custom Variables Analytics at Piwik.

Section

title	Details

Section

index	true
title	Related Macros

Display Table

doctype	macro
render-no-hits-as-blank	true
render-mode	definition
where	$<Categories> = [/ Feature / Custom Variable]
exclude-self	true

Section

title	Subordinate Macros

Display Table

doctype	macro
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

Section

required-permissions	write-access
title	Notes

Section

title	References

Section

title	Resources

Custom Variables Analytics - information on Piwik's website.
Using Custom Variables in Piwik - a short tutorial on Piwik's website on how to use custom variables.

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 3

New Version Current

Key

About

Keep up-to-date!

Powered by