Push

Pushes a custom dimension for a particular user to the VWO server. It is used for post-segmenting the data in the campaign reports.

Description

The API method:

Validates the parameters passed
Sends a call to the VWO server for associating custom dimensions for the user to the same users that are part of the FullStack campaign.

The API method accepts a custom dimension key - customDimensionKey, custom dimension value - customDimensionValue, and user-id - userId.

customDimensionKey is the unique key associated with a particular custom dimension made in VWO application.
customDimensionValue is the value you want to tag a custom dimension with.
userId is the unique id associated with the user for identification.

Parameter Definitions

Parameter	Type	Description
customDimensionKey Required	String	The custom dimension key to uniquely identify a custom dimension.
customDimensionValue Required	String	The custom dimension value for a custom dimension.
userId Required	String	User ID, which uniquely identifies each user. Important*: This User ID must match the User ID provided to activate or getVariation API.

Parameter

Type

Description

customDimensionKey Required

String

The custom dimension key to uniquely identify a custom dimension.

customDimensionValue
Required

String

The custom dimension value for a custom dimension.

userId
Required

String

User ID, which uniquely identifies each user.

*Important**: This User ID must match the User ID provided to activate or getVariation API.

Returns

A boolean value based on whether the call was made to the VWO server.

Value	Type	Description
true	Boolean	If call is successfully being made to the VWO server for post-segmentation
false	Boolean	If validation fails or call is not made

Usage

isSuccessful = vwoClientInstance.Push(customDimensionKey, customDimensionValue, userId)