Export Fields
Fields that provide details for individuals and sessions.
Parameters
A unique identifier for the Individual that combines all Users with the same User App Key. For example, if you’ve identified user 123 whenever they visit your site, their Individual will include all of their Sessions across devices, browsers, etc. The IndvId value is not visible within the Fullstory UI, but it is part of the session URL.
A unique identifier for a user cookie on a given device/browser. This ID may be reset if the User clears their cookies, switches devices, changes browsers, etc. This field is not visible within the Fullstory UI—see UserAppKey below for more information.
The identifier for a particular session, within the context of a single user. Use SessionId
and UserId
together as a compound key to uniquely identify sessions across all export data.
Note: To use this value in the rest of our APIs, you will need to concatenate it with UserId: UserId:SessionId
.
The identifier for a particular page load/refresh, within the context of a single session. Use PageId
, SessionId
, and UserId
together as a compound key to uniquely identify pages across all export data.
UTC RFC 3339 timestamp for when the cookie associated with UserId was first seen.
The user identifier that was passed to Fullstory from your system using FS.identify. This field is visible in the Fullstory UI as "User ID" when looking at a user's profile.
The display name that was set via FS.identify or FS.setUserVars.
The email address that was set via FS.identify or FS.setUserVars.
The absolute time when the session was started, in UTC, represented as a dateTime from the XML Schema Specification, e.g. 2018-01-04T20:07:11.191Z
.
Event Fields
Fields that provide details for the kind of event that was triggered.
Parameters
The absolute time when the event occurred, in UTC, represented as a dateTime from the XML Schema Specification, e.g. 2018-01-04T20:07:11.191Z.
The name of the event, if it is a Analytics Event. The EventType
field will have "custom" as it's value as well for instrumented events.
Where applicable, this contains the text of the event target and its child elements. For example, if the user clicked a button that says “Pay now”, the event target text would be “Pay now”. Long text may be truncated in some cases for performance reasons.
Where applicable, this contains the CSS selector for the event target. This will be a fully qualified descendant selector, starting from the HTML element, and including all CSS selectors of elements that appear in the DOM when walking from the HTML element through its children to the event target.
If present, indicates that the event has some duration associated with it. When the EventType
is seen
, this value is the duration in milliseconds that the watched element was rendered.
If present, indicates that the event has a secondary duration associated with it. When the EventType
is seen
, this value is the duration in milliseconds that the watched element was visible.
The time in milliseconds since the page was loaded.
The time in milliseconds since the session was started.
Your customer clicked one or more elements on the page many times in rapid succession, potentially because they were frustrated. For each of the click events in this series of clicks, the numeric value of this field is a running total of the number of clicks that have occurred. It will be zero for click events that were not part of a series of rage clicks. Learn more about rage clicks.
Your customer clicked something, but nothing happened. Will be 1 for dead clicks, zero for non-dead clicks.
Possible values:
0
the event did not generate an error
1
the event generated an error*
2
the event generated a console error
3
the event generated an uncaught exception
Your customer clicked something and an error was generated, either by an uncaught exception occurring, or by logging an error to the console. The value indicates the type of error generated.
*Prior to 06-21-2021, this field did not distinguish between different types of errors.
Your customer entered text or navigated to a URL that was suspicious. When set to zero, nothing was suspicious. When 1, it indicates a possible SQL injection attack. When 2, it indicates a possible cross site scripting attack. Learn more about suspicious activity detection.
The cumulative layout shift score, only present when EventType
is cumulative_layout_shift
.
The duration, in milliseconds, of a first input delay measurement on a page. Only present when EventType
is first_input_delay
.
Error kind token indicating error (if an error is present) for this event. Typically will only be provided if EventType
ends with _error
.
Fields relevant to the error (if an error is present). Typically used to indicate custom properties that triggered an error.
If the EventType
is exception
, then this is the javascript source file associated with the error.
Android only. If the EventType
is exception
, then this is the mobile source file associated with the error.
Page Fields
Fields that describe browser display and page statistics.
Parameters
The name of the page, as set by FS('setProperties')
.
The absolute time when the page was, in UTC, represented as a dateTime from the XML Schema Specification, e.g. 2018-01-04T20:07:11.191Z
. Note: All of the Page-
fields correspond to a unique "instance" of a page. A single page instance is represented by a unique combination of UserId
, SessionId
and PageId
.
The total time this User spent on this page during this session (milliseconds). This is not a running total; every event for a given page will show the same total duration.
The active time (mouse movement, text entry, clicks, etc.) this User spent on this page during this session (milliseconds). This is not a running total; every event for a given page will show the same total duration.
The full URL of the page on which the given event occurred.
The page from which the user reached this page. The referrer may be empty if the user manually entered the page URL, or if the referrer has been scrubbed, etc.
The IP address corresponding to a session. IP addresses are used by Fullstory to infer a user's general location. IP address recording can be disabled if desired. More information on disabling IP address recording here.
The latitude/longitude corresponding to this session. These values are derived using IP geolocation, which is only capable of pinpointing a user’s general area, often just at the city level, not their exact location.
The full user agent string for the system on which this session was recorded.
Possible values: Chrome
, Firefox
, Internet Explorer
, Microsoft Edge
, Mobile App
, Opera
, Safari
, Yandex
, Robot
, Unknown
The browser that was used for this session, as derived from the User Agent. New values may be added to this list at a later date.
The browser version that was used for this session, as derived from the User Agent.
Possible values: Desktop
, Mobile
, Tablet
, Robot
, Unknown
The device type that was used for this session, as derived from the User Agent. New values may be added to this list at a later date.
Possible values: Web
, Native Mobile
The platform that was used for this session.
Possible values: Android
, Chrome OS
, Linux
, iOS
, OS X
, Windows
, Windows Phone
, Robot
, Unknown
The operating system type that was used for this session, as derived from the User Agent. New values may be added to this list at a later date.
The width of the CSS Resolution of the screen in pixels.
The height of the CSS Resolution of the screen in pixels.
The width of the viewport size of the browser in pixels.
The height of the viewport size of the browser in pixels.
The total number of events that occurred on the page. Note: When the PagePlatform
is Web
, the PageNum-
fields indicate the number of events that occurred between when the HTML page was first rendered until the user navigated away or closed the tab. When the PagePlatform
is Native Mobile
, the PageNum-
fields indicate the number of events that occurred between when an app was opened or foregrounded andbackgrounded or closed.
The total number of Fullstory-derived events that occurred on the page. This includes FS API validation events such as rate-limiting and invalid arguments.
The number of times the JavaScript function console.log()
was called, plus the number of times console.info()
was called on the page. This is a running total for the page, and will steadily increase until the user navigates to a new page.
The number of times console.warn()
was called on the page. This is a running total for the page, and will steadily increase until the user navigates to a new page.
The number of times console.error()
was called, plus the number of JavaScript errors that occurred on the page. This is a running total for the page, and will steadily increase until the user navigates to a new page.
An internal identifier used by Fullstory to group pages together for Page Insight analysis.
A percentage representing the max depth that the user scrolled down the page. Present only for EventType
navigate
.
Load Fields
Fields that describe content loading performance.
Parameters
The time (in milliseconds) that DOMContentLoaded fires, when the initial HTML document has been loaded and parsed. Often this milestone occurs before stylesheets, images, and sub-frames finish loading, so the DOMContentLoaded event occurs before a page is done painting. Present only for EventType
load
.
The time (in milliseconds) that the onload event or "Page Load" fires, when the whole page and all of its dependent resources have finished loading. Page Load often occurs later, after the point in time when the page is rendered and interactive for a user. Present only for EventType
load
.
The First Contentful Paint time (in milliseconds) for the page load. First Contentful Paint is the moment when the first "above-the-fold" layout change has happened and when web fonts have loaded. Present only for EventType
load
.
The Largest Contentful Paint time (in milliseconds) for the page load. Largest Contentful Paint is the time that it takes for the largest "above-the-fold" element to be rendered on a page. Present only for EventType
load
.
Request Fields
Fields included for events that describe XHR requests.
Parameters
If the EventType
is request
, the URL for the corresponding XHR request.
If the EventType
is request
, the HTTP request method for the corresponding XHR request.
If the EventType
is request
, the HTTP response status code for the corresponding XHR request.
Mobile Only Fields
Additional fields for accounts with mobile apps features.
Parameters
The display name for the mobile application. Target display name for iOS, and application label for Android.
The bundle ID that uniquely identifies an application. Typically starts with com.<company_name>.<app>
.
The model of the mobile device.
The Vendor of the mobile device.
The version of the mobile application.
The OS version of the mobile device.
The name of the application's view. By default:
For iOS: the name of the UIViewController
class for the screen is used, customize it using set screen name for iOS.
For Android: The name of the Activity
is used.
Individual Fields
In addition to the fields outlined below, any user variables set with FS.identify()
or FS.setUserVars()
will be included in the export.
Parameters
A unique identifier for the Individual that combines all Users with the same User App Key. For example, if you’ve identified user 123 whenever they visit your site, their Individual will include all of their Sessions across devices, browsers, etc. The IndvId value is not visible within the Fullstory UI, but it is part of the session URL.
The time that this user had their first session recorded by Fullstory.
The user identifier that was passed to Fullstory from your system using FS.identify. This field is visible in the Fullstory UI as "User ID" when looking at a user's profile.
The display name that was set via FS.identify()
or FS.setUserVars()
.
The email address that was set via FS.identify()
or FS.setUserVars()
.
The total number of sessions that have been recorded for this user.
The total number of pages that have been visited by this user.
The total number of events associated with this user.
The total length of time in seconds of the user's recorded sessions.
The total active time in seconds for the user's recorded sessions.
The average length of time of the user's sessions.
The average active time of the user's sessions.
The longest session time for the user.
The number of pages visited in the user's last session.
The number of events in the user's last session.
The time in seconds of the user's last session.
The active time in seconds of the user's last session.
When the most recent session for this user started.
The last page that the user visited.
The IP address for the user's most recent session.
The latitude and longitude for the user's most recent session.
The time for the last event in the user's most recent session.
The browser for the user's most recent session.
The device for the user's most recent session.
The platform for the user's most recent session.
The OS for the user's most recent session.