Set Page Properties

Set page properties

Use the FS('setProperties') function with type set to 'page' to capture information about the current page. Page properties are available to search from the time of the FS('setProperties') call until the end of the page. The end of the page is defined as any change to the URL host or path. To continue capturing page properties after a host or path change, the FS('setProperties', { type: 'page' }) API must be called again.

You can call FS('setProperties', { type: 'page' }) multiple times on the same page, with or without the optional pageName field. When doing so, the set of provided properties will be merged with any prior properties you sent.

Parameters

type string required

Specify page to scope this call to page-level properties.

properties object required

A JSON object containing additional information about the page that will be indexed by Fullstory.

Special Fields

These are reserved field names that can be included in properties that have special meaning and usage.

pageName string optional

The value provided in this field will automatically become a Page, which can be used in a variety of places within Fullstory, such as Journeys.
Note: This value will take precedence over any URL-based page definitions you may have previously created. If this is not desired, please use another field to designate the page name.

Limits

• Capture up to 20 unique properties (exclusive of pageName) on a single page.

• Capture up to 500 unique properties across all pages.

• The pageName field is limited to 1,000 unique pageName values across your site. Any new pageName values sent past this limit will be ignored.

• If two different pageName values are sent while on the same page, the later API call will be ignored. Since this field is optional, a blank or missing pageName is not considered a change and will not affect the API call.

Additional Information

• Sending custom page data to Fullstory.

FS('setProperties', { type: 'page', properties });

Example Invocation

Capturing cart size on the Checkout page

FS('setProperties', {
  type: 'page',
  properties: {
    pageName: 'Checkout',
    cart_size: 3,
  }
});

Adding a coupon code to the previous properties

FS('setProperties', {
  type: 'page',
  properties: {
    coupon_code: 'spring2022',
  }
});