Setting custom API properties

There are several ways to set custom data in FullStory. Each of them can take a unique set of properties. For instance, a custom field is one that you define that FullStory saves, displays, and that can be used in search.

For example, pricingPlan_str is a custom field, as you can see by the formulation of its name: all custom field names have an underscore and suffix. More specifically, custom fields must be named using the pattern ident_type, where ident is a sequence of alphanumeric characters A-Z, a-z, or 0-9 and type is a short suffix that denotes the type of the field, which can be any of these. Custom field names must start with an alphabetic character (A-Z or a-z).

See more examples below:

Type suffix	Meaning	Example
`str`	string	{ "nickname_str": "boo" }
`int`	integer	{ "PasswordResets_int": 49 }
`real`	real	{ "amtAbandonedInCart_real": 3.84 }
`date`	date in ISO-8601 UTC format	{ "initialSignupDate_date": new Date("2014-03-11T13:19:23Z") }
`bool`	boolean	{ "didSelfServiceSignup_bool": true }
`strs`	list of strings	{ "cartIds_strs": ["a123", “b456”] }
`ints`	list of integers	{ "ids_ints": [123, 456, 789] }
`reals`	list of reals	{ "coordinates_reals": [40.7, -74.0] }
`dates`	list of ISO-8601 UTC format dates	{ "date_range_dates": [ new Date("2014-03-11T13:19:23Z"), new Date("2014-08-11T13:19:23Z") ] }
`bools`	list of booleans	{ "preferences_bools": [true, false, true] }

All of the fields you capture will be visible in the FullStory UI using the Event Scope drop down, as well as in Settings > Data Management > Properties. Additionally, you have the ability to see what API events are connected to specific properties in the Connections column.

Learn more about common troubleshooting tips for custom user data.

Articles in this section

Setting custom API properties

Need to get in touch with us?