Set User Variables

FS.setUserVars(customVars);

Each time a page loads from a user you can identify, you'll want a bit of JavaScript to call the FS.identify function to associate your own application-specific id with the active user.

Parameters

NameDescription
customVarsA JSON object with key/value pairs that provides additional information about your user.

Special Fields

NameDescription
displayNameThe value of displayName is displayed in the session list and on the user card in the app.
emailThe value of email is used to let you email the user directly from the app. The email value can also be used to retrieve users and sessions via the Get User and List Sessions HTTP APIs.

Limits

  • Sustained calls are limited to 12 calls per minute, with a burst limit of 5 calls per second.

Additional Information

Example Invocation

FS.setUserVars({
 displayName : 'Daniel Falko',
 email : 'daniel.falko@example.com',
 pricingPlan_str : 'free',
 popupHelp_bool : true,
 totalSpent_real : 14.50
});