Skip to main content
Version: v2

Capture Data

To begin capturing data start by installing the FullStory Snippet. The FullStory Snippet initializes the FullStory Browser API and requests a copy of the FS Script. Upon successful completion of these tasks, capture will start immediately. To manually delay the onset of data capture, see Manually Delay Data Capture.


Stop Data Capture

Stop capturing a session.

FS('shutdown') can be invoked immediately after the FullStory snippet is executed. It is idempotent, meaning it quietly does nothing if you call it multiple times after the first invocation. Call FS('restart') to begin capturing again.

Once FS('shutdown') is invoked, FullStory will no longer receive data from the user's device. When running FullStory in a web browser, data capture begins automatically once the page is loaded from the server; FS('shutdown') must be called each time after a page is loaded.

Additional Information

FS('shutdown')

Example Invocation

FS('shutdown');

Restart Data Capture

Restart session data capture after it has been shutdown.

FS('restart') is used to begin data capture again after FS('shutdown') has been called. Like FS('shutdown'), it is idempotent, meaning it does nothing if you call it multiple times after the first invocation.

FS('restart')

Example Invocation

FS('restart');

Manually Delay Data Capture

Depending on your setup, you might want additional control over when data capture starts. A typical example of this would be a site where user consent is required in order to capture data.

To manually delay capture, set window['_fs_capture_on_startup'] to false. When you are ready to start capture, you can call FS('start').

FS('start') is also idempotent, meaning it does nothing if you call it multiple times after the first invocation.

window['_fs_capture_on_startup'] = false;

Example Invocation

window['_fs_capture_on_startup'] = false;

// ...
// Code that needs to run before capture
// ...

// Manually start capture
FS('start');