User Context

The user context serves as a unique identifier for individual users and plays a critical role in ensuring consistent feature rollouts across sessions and devices. Typically represented as a object, the user context includes an id key that uniquely identifies the user.

In addition to the user ID, the context can incorporate various attributes to support advanced targeting and segmentation strategies. These may include:

• custom-variables: User-specific data points for personalized experiences.
• user-agent: Information about the user's device, browser, or operating system.
• ip-address: Location-based data to enable geo-targeting.

By leveraging these attributes, organizations can deliver precisely targeted features, maintain personalization consistency, and conduct granular experimentation for improved user engagement and performance analysis.

#Usage

# Define the user context object to identify and provide user-specific details
user_context = {
  id: 'unique_user_id',
  customVariables: { age: 25, location: 'US' },
  userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36',
  ipAddress: '1.1.1.1',
  bucketingSeed: 'your-bucketing-seed'
}

# The same user context can be used across different APIs. For example -

# Returns a flag object which can be used to get flag's status or variable(s)
flag = wingify_client.get_flag('feature_key', user_context)

# Track a metric conversion for the specified event-name
wingify_client.track_event('event-name', user_context)

# Send a user attribute to Wingify
wingify_client.set_attribute({userType: 'paid'}, user_context)

#User Context keys

  <th>
    Type
  </th>

  <th>
    Description
  </th>
</tr>

  <td>
    String
  </td>

  <td>
    Unique user ID for the current user. 'id' is the only required property in userContext. This ID should be a unique identifier for the current user which you need to pass to Wingify. [Read more here](https://developers.wingify.com/v3/docs/user-id-management)  .
  </td>
</tr>

<tr>
  <td>
    **userAgent**<br />_Optional_
  </td>

  <td>
    String
  </td>

  <td>
    The userAgent object for the current user, can be used for targeting & segmentation.
  </td>
</tr>

<tr>
  <td>
    **ipAddress**<br />_Optional_
  </td>

  <td>
    String
  </td>

  <td>
    IP Address of the current user, can be used for targeting & segmentation.
  </td>
</tr>

<tr>
  <td>
    **customVariables**<br />_Optional_
  </td>

  <td>
    Hash
  </td>

  <td>
    Any additional details of the current user that you want to push to Wingify can be added here as key-value pairs, can be used for targeting & pre-segmentation.
  </td>
</tr>

<tr>
  <td>
    **bucketingSeed**<br />_Optional_
  </td>

  <td>
    String
  </td>

  <td>
    A custom seed value to be used for bucketing the user. If provided, this value will be used as the bucketing ID instead of the user ID.
  </td>
</tr>