Docs

track().variable

Suggest Edits

❗️

Deprecated

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

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

Syntax

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

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

Parameters

index (number, required)

The index where the variable is stored.

Note: If setIncludeDefaultCustomVars(true) is set, you can only use an index greater than 2 because this method automatically tracks some items under the index 1-2. The setIncludeDefaultCustomVars(true) method is set by default.

name (string, required)

The name of the variable. Valid format: UTF-8.

value (string, optional)

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

Examples

To set a custom variable in the screen scope and send it with a screen view:

TrackHelper.track()
  .variable(1, "rating", "5");

TrackHelper.track()
  .screen("example/product-rating")
  .title("Product rating")
  .with(getTracker());

TrackHelper.track()
  .variable(1, "rating", "5")

TrackHelper.track()
  .screen("example/product-rating")
  .title("Product rating")
  .with(tracker)

Another way to set a custom variable and send it with a screen view:

TrackHelper.track()
  .variable(1, "rating", "5")
  .screen("example/product-rating")
  .title("Product rating")
  .with(getTracker());

TrackHelper.track()
  .variable(1, "rating", "5")
  .screen("example/product-rating")
  .title("Product rating")
  .with(tracker)

Notes

  • The screen scope refers to events like a screen view or file download and holds a captured variable for each event. The value is removed after an event is called.

Related methods

Updated 2 days ago