FS Recording Client API Requirements

The Recording Client API allows users to record custom data in FullStory via a Javascript API.  FS.event, FS.setUserVars, and FS.identify each receive as arguments a JSON object containing the custom data.  The contents of these JSON objects are validated before they are recorded in FullStory.  The validation requirements are listed in detail below.

General Payload Requirements

The payload must be a valid JSON object.  For more details about the JSON format, visit https://www.json.org/.  The maximum payload size for a single Recording Client API call is 512KB.  Any payload larger than 512KB will be rejected.

Custom Event Name Requirements

Custom event names must be strings no longer than 250 characters.  There are no reserved characters for custom event names, so any characters or symbols can be used.  Custom events with names longer than 250 characters will be rejected.  Empty string custom event names (i.e. "") will also be rejected.

Custom Property Name Requirements

Custom properties must be named using the pattern ident_type. Ident is a sequence of alphanumeric characters A-Z, a-z, or 0-9 and underscores ("_"). Type is a short suffix that denotes the type of the property. Custom properties names must start with an alphabetic character (A-Z or a-z).  The maximum custom property name length is 512 characters, including the type suffix.  There are 10 valid type suffixes, which are listed in the table 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]
}

In addition to these types, properties may also contain nested objects.  Custom properties that take nested objects should not be type suffixed.  Custom properties within nested objects must still conform to the naming requirements outlined in this section.  For nested custom events, the property name including the dotted concatenation of all its parent properties must still be under the length limit of 512 characters. 

Example:

FS.event(“exampleEvent”, {
  “nonNestedProperty_str”: “example string”,
  “singleNestedProperty”: {
    “childProperty_bools”: [false, false, true, false]
  },
  “multiNestedProperty”: {
    “childProperty1_date”: new Date("2014-03-11T13:19:23Z"),
    “childProperty2”: {
      “nestedChildProperty_int”: 1
    }
  }	
});

Custom Property Value Requirements

The value of a custom property must conform to the type suffix for the property.  If it doesn’t, the property will be rejected.  Custom properties have a maximum value size of 4096 bytes.  If the value for the property is larger than this limit, the property will be rejected.

Reserved Properties

For FS.setUserVars and FS.identify, there are five reserved property names.  These properties are used for special functionality in the FullStory app.  Reserved property names should not be type suffixed.  These reserved property names do not apply to FS.event.

Reserved Property Name

Type

Maximum Value Length

What it does

uid

string

256 characters

Explicitly sets the unique identifier for the user

displayName

string

256 characters

Displays nice-looking user names

email

string

128 characters

Activates "Email this user"

acctId

string

256 characters

Deprecated

website

string

1024 characters

Deprecated

Custom Property Cardinality Limiting

There is an organization-wide limit on the total number of unique custom property names that FullStory will accept.  This limit is 5,000 unique custom properties.  Both FS.event and FS.identify/FS.setUserVars property names count towards this single organization wide limit.  

  • A given property name can be sent any number of times and will only count once toward the cardinality limit.

  • Properties with the same name sent with FS.setUserVars and FS.event are considered different properties for the cardinality limit.  Similarly, properties with the same name sent with FS.identify and FS.event are considered different properties with this limit.

  • Properties with the same name sent with FS.identify and FS.setUserVars are considered the same property for the cardinality limit.

  • Properties with the same property name but different event names are considered different properties for the cardinality limit.

If the cardinality limit is reached for an organization, no new property names will be accepted for the organization.  New property names will be rejected and will not be recorded by FullStory.  This limit will slowly reset as property names become older than the data retention window.  If your organization accidentally exceeded the cardinality limit and need it more quickly, contact FullStory Support.

Custom Property Rate Limiting

There are per-session rate limits for the number of calls to Recording Client APIs.  There are burst limits and sustained limits.  These limits are separate for FS.event and FS.identify/FS.setUserVars.  For FS.event, the burst limit is 10 call per second and the sustained limit is 30 calls per minute.  For FS.setUserVars, the burst limit is 5 calls per second and the sustained limit is 12 calls per minute.  If these limits are exceeded for a given session, subsequent Recording Client API calls for that session will be not be recorded in FullStory.

Troubleshooting

If you notice missing or malformed Recording Client API payloads in FullStory, this article provides guidance to troubleshoot and resolve the issue.

Can’t find what you’re looking for?

The FullStory team awaits your every question.

Contact Us