Provide a single custom variable to the Piwik context.

Name
Set One Custom Variable
Categories

 

Description

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

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.

Piwik. Custom Variables Analytics

Properties

Here is an overview over the options for this macro:

 

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.

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.

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.

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.

Scope

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

You have two options:

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.

Related Macros

Set Multiple Custom Variables
Provide a set of custom variables to the Piwik context.

Resources