getIncludeDefaultCustomVariables

The getIncludeDefaultCustomVariables() method returns the current state of the flag that determines whether default custom variables (platform, OS and app version) are added to each tracking event.

Syntax

const includeDefaultCustomVariables = await PiwikProSdk.getIncludeDefaultCustomVariables();

Returns

Whether default custom variables are added to each tracking event.

• true: Default custom variables are added.
• false: Default custom variables aren’t added.

Type: boolean

Examples

To read the current state:

const includeDefaultCustomVariables = await PiwikProSdk.getIncludeDefaultCustomVariables();

Related methods

• setIncludeDefaultCustomVariables()