wf.getAttributes(scope, names)

Retrieve a subset of attributes that have been previously stored using setAttributes(). Only attributes that match the names parameter will be returned.

Syntax

1
wf.getAttributes(scope: 'user' | 'pageview', names: string[])

Parameters

• scope: 'user' | 'pageview' - The scope of the attributes to retrieve.
• names: string[] - An array of attribute names to retrieve.

Example implementation

1
// Call the wf.ready() function the Browser API is available
2
wf.ready(function() {
3
  // Set attributes for the current user
4
  wf.setAttributes('user', {
5
    userSegment: 'enterprise'
6
  })
7
})
8
9
// Retrieve the attributes
10
const attributes = wf.getAttributes('user', ['userSegment'])
11
  console.log(attributes)

Returns

An object containing the attributes that match the names parameter.

Example

1
{
2
  "userSegment": "enterprise"
3
}