Skip to main content
Version: v2

Getting Started

The FullStory Browser API allows developers to

  • manage data capture
  • consume custom event and user profile data
  • generate session replay URLs that can be used to integrate replay deep links with other platforms.

What's new in version 2?​

We've redesigned our Browser API from the ground up providing a sleek consistent interface that’s easy to use and futureproof. This means any new features won't require a snippet update. In addition, the following changes have been made:

  • Type suffixes are no longer required for custom properties. We will infer all types so you don't have to. Additional type fidelity can be achieved by providing an optional schema. See Custom Properties.
  • Each API method has a corresponding asynchronous version that waits until capture has started to resolve. See Asynchronous Methods.

Browser API v2 Beta Release​

🎉 Browser API v2 is officially in beta release! 🎉

Who can join the beta release?​

Anyone is welcome to join the beta release who is not affected by the following caveat:

Browser API v2 is not currently supported in WebViews. If your website is injected into a native mobile app running the Mobile SDK, Browser API v2 will not work as expected.

How do I join the beta release?​

To join the beta release, first familiarize yourself with the System Requirements (the part about being on snippet version 2.0 redirects back to this page), have a look at what's new, and then follow the instructions for your setup:

Installing the FullStory Snippet​

A couple of notes about the data capture snippet​

  • It’s super small, asynchronous, and designed to be unnoticeable to your users. You can read more about the negligible performance impact of FullStory in this article.
  • Once the FullStory script loads, it captures all web based interactions and mutations.

Snippet customers​

  • Locate your org id and enter it in the box below.
  • Copy the resulting snippet code.
  • For existing customers, locate the current snippet code in your application and replace it with this code. (Typically this is found in the <head> of your application's main template.)
  • For new customers, place this code in the <head> of your website.
  • If you use a tag manager like Google Tag Manager to install the snippet, you'll want to update your snippet there instead of directly in the <head> of your website.
<script>
console.warn('please enter an org id 😄')
</script>

NOTE:​

For existing customers, make sure you don't overwrite any additional global properties you may have set like asset map id:

window['_fs_asset_map_id'] = '<your asset map id>';

or any alternate properties like a custom namespace:

window['_fs_namespace'] = 'FullStory';

Browser SDK customers​

  • Bump the version of @fullstory/browser in your package.json file to the latest beta release: 2.0.0-beta.4.
  • To install the Browser SDK on a new project, run
npm install @fullstory/browser@2.0.0-beta.4

Be sure to review the updating guide in the README. At a high level, version 2 of the Browser SDK uses named imports instead of wildcard ('*') imports. For existing customers, replace the following import statement:

import * as FullStory from '@fullstory/browser';

with the following:

import { FullStory, init } from '@fullstory/browser';

Auto Capture Functions​

Auto capture can be controlled via capture stop, restart, and consent functions.

You can also add a callback handler that gets executed when auto capture is fully initialized.

Custom Data Capture​

Custom event, user profile data, and page data can be captured during a user browsing session. These data are indexed by FullStory for search, segment, and metrics creation.

User identity can be managed with the identify and anonymize.

Getting Session Replay URLs​

Session Replay URLs can be generated during a user session.

These URLs can be used to integrate session replay links with other tools (for example, integrating with Sentry for error tracking or New Relic for tracing).

Rage Clicks​

The Rage Click Hook provides a method to react to FullStory frustration events directly in the browser to trigger workflows locally.

More details about Ragehook use cases can be found here.