Docs

track().visitVariables

Suggest Edits

❗️

Deprecated

Audience Manager is no longer available in the latest product version.

The track().visitVariables() method sets a custom variable in the visit (session) scope. The value can be sent to Piwik PRO with a screen view or other event.

Syntax

TrackHelper.track()
  .visitVariables(index, "name", "value");

TrackHelper.track()
  .visitVariables(index, "name", "value")

Parameters

index (number, required)

The index where the variable is stored.

Note: If setIncludeDefaultCustomVars(true) is set, you can’t use the index 4-5 because this method automatically tracks some items under these indexes. The setIncludeDefaultCustomVars(true) method is set by default.

name (string, required)

The name of the variable. Valid format: UTF-8. Limited to 200 characters.

value (string, optional)

The value of the variable. Valid format: UTF-8. Limited to 200 characters.

Examples

To set a custom variable in the visit (session) scope and send it with a screen view:

TrackHelper.track()
  .visitVariables(1, "age", "25")

TrackHelper.track()
  .screen("example/welcome")
  .title("Welcome")
  .with(getTracker());

TrackHelper.track()
  .visitVariables(1, "age", "25")

TrackHelper.track()
  .screen("example/welcome")
  .title("Welcome")
  .with(tracker)

Notes

  • The visit (session) scope refers to the entire session and holds the captured custom dimension for the entire session.

Related methods

Updated 6 days ago