Please see Fullstory's developer documentation for more detailed API information:
Note: We officially released V2 of our Capture Data Browser API on November 1st, 2023. If you're still using V1 of our Browser API, please refer to our V1 API documentation found here.
If you were using Fullstory prior to August 3rd, 2023 and aren't sure which version of our Browser API is compatible with the data capture snippet deployed on your website, please refer to these instructions to confirm.
By default, Fullstory data capture will begin immediately once the Fullstory data capture snippet initializes the Fullstory Browser API and requests a copy of the Fullstory Script.
However, with our V2 Capture Data Browser API, there is a way to manually delay the onset of data capture by utilizing window['_fs_capture_on_startup']. For example, you could consider only starting data capture on your website once a user has consented.
The Fullstory JavaScript API also contains two other methods which can be used to “shutdown” and “restart” data capture. Either can be called immediately after the Fullstory data capture snippet is executed.
- The
shutdownAPI stops capturing the current page immediately, but has no other effect. If ”shutdown” is called immediately after the snippet is executed, data capture won't start (and a new page won't be created) until the start or restart API is called. - The
startorrestartAPIs will start up again, with a new page, meaning, while it doesn't refresh the window, it starts capturing again as though it were a new page.
Both APIs are idempotent, meaning that they will quietly do nothing if you call it multiple times. For example, if you call ”shutdown” when Fullstory is not currently capturing, it will simply do nothing.
Lastly, it is important to note that using ”shutdown” and ”restart” without a 30 minute inactivity period will not cause a new session in Fullstory.