setCustomDimensionValue

The setCustomDimensionValue() method sets the value for a custom dimension. The value can be sent to Piwik PRO with a page view or other event.

Syntax

setCustomDimensionValue(customDimensionID, customDimensionValue)
setCustomDimensionValue(customDimensionId, customDimensionValue): void
setCustomDimensionValue(customDimensionId, customDimensionValue): void
setCustomDimensionValue(customDimensionId, customDimensionValue): void
setCustomDimensionValue(customDimensionId, customDimensionValue): void
setCustomDimensionValue(customDimensionId, customDimensionValue): void
setCustomDimensionValue(customDimensionId, customDimensionValue): void

Parameters

customDimensionId (number, required)

The ID of the custom dimension.

customDimensionValue (string, required)

The value of the custom dimension.

Examples

To set the value for a custom dimension and send it with a page view:

_paq.push(["setCustomDimensionValue", 1, "Jane Doe"]);  
_paq.push([“ping”]);
setCustomDimensionValue(1, "Jane Doe"): void
setCustomDimensionValue(1, "Jane Doe"): void
setCustomDimensionValue(1, "Jane Doe"): void
setCustomDimensionValue(1, "Jane Doe"): void
setCustomDimensionValue(1, "Jane Doe"): void
setCustomDimensionValue(1, "Jane Doe"): void

Notes

  • If you set a custom dimension, its value will be used in all tracking requests within the page load.

Related methods