Export Fields

Fields that provide details for individuals and sessions.

Parameters

• IndvId int64 optional

  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.

• UserId int64 optional

  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.

• SessionId int64 optional

  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.

• PageId int optional

  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.

• UserCreated timestamp optional

  UTC RFC 3339 timestamp for when the cookie associated with UserId was first seen.

• UserAppKey string optional

  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.

• UserDisplayName string optional

  The display name that was set via FS.identify or FS.setUserVars.

• UserEmail string optional

  The email address that was set via FS.identify or FS.setUserVars.

• SessionStart timestamp optional

  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

• EventStart timestamp optional

  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.

• EventType string optional

  The type of event that was recorded. See Event Types

• EventSubType string optional

  If present, a refinement of the EventType field. See Event Sub Types

• EventCustomName string optional

  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.

• EventTargetText string optional

  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.

• EventTargetSelector string optional

  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.

• EventDuration int optional

  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.

• EventSecondaryDuration int optional

  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.

• EventPageOffset int optional

  The time in milliseconds since the page was loaded.

• EventSessionOffset int optional

  The time in milliseconds since the session was started.

• EventModFrustrated int optional

  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 Click. Learn more about Rage Click.

• EventModDead int optional

  Your customer clicked something, but nothing happened. Will be 1 for dead clicks, zero for non-dead clicks.

• EventModError int optional

  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.

• EventModSuspicious int optional

  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.

• EventCumulativeLayoutShift float optional

  The cumulative layout shift score, only present when EventType is cumulative_layout_shift.

• EventFirstInputDelay int optional

  The duration, in milliseconds, of a first input delay measurement on a page. Only present when EventType is first_input_delay.

• EventVarErrorKind string optional

  Error kind token indicating error (if an error is present) for this event. Typically will only be provided if EventType ends with _error.

• EventVarFields string optional

  Fields relevant to the error (if an error is present). Typically used to indicate custom properties that triggered an error.

• EventWebSourceFileUrl string optional

  If the EventType is exception, then this is the javascript source file associated with the error.

• EventMobileSourceFile string optional

  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

• PageName string optional

  The name of the page, as set by FS('setProperties').

• PageStart timestamp optional

  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.

• PageDuration int optional

  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.

• PageActiveDuration int optional

  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.

• PageUrl string optional

  The full URL of the page on which the given event occurred.

• PageRefererUrl string optional

  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.

• PageIp string optional

  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.

• PageLatLong string optional

  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.

• PageUserAgent string optional

  The full user agent string for the system on which this session was recorded.

• PageBrowser string optional

  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.

• PageBrowserVersion string optional

  The browser version that was used for this session, as derived from the User Agent.

• PageDevice string optional

  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.

• PagePlatform string optional

  Possible values: Web, Native Mobile

  The platform that was used for this session.

• PageOperatingSystem string optional

  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.

• PageScreenWidth int optional

  The width of the CSS Resolution of the screen in pixels.

• PageScreenHeight int optional

  The height of the CSS Resolution of the screen in pixels.

• PageViewportWidth int optional

  The width of the viewport size of the browser in pixels.

• PageViewportHeight int optional

  The height of the viewport size of the browser in pixels.

• PageNumEvents int optional

  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 PagePlatformis Native Mobile, the PageNum- fields indicate the number of events that occurred between when an app was opened or foregrounded andbackgrounded or closed.

• PageNumDerivedEvents int optional

  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.

• PageNumInfos int optional

  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.

• PageNumWarnings int optional

  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.

• PageNumErrors int optional

  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.

• PageClusterId int optional

  An internal identifier used by Fullstory to group pages together for Page Insight analysis.

• PageMaxScrollDepthPercent int optional

  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

• LoadDomContentTime int optional

  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.

• LoadEventTime int optional

  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.

• LoadFirstPaintTime int optional

  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.

• LoadLargestPaintTime int optional

  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

• ReqUrl string optional

  If the EventType is request, the URL for the corresponding XHR request.

• ReqMethod string optional

  If the EventType is request, the HTTP request method for the corresponding XHR request.

• ReqStatus int optional

  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

• AppName string optional

  The display name for the mobile application. Target display name for iOS, and application label for Android.

• AppPackageName string optional

  The bundle ID that uniquely identifies an application. Typically starts with com.<company_name>.<app>.

• AppDeviceModel string optional

  The model of the mobile device.

• AppDeviceVendor string optional

  The Vendor of the mobile device.

• AppVersion string optional

  The version of the mobile application.

• AppOsVersion string optional

  The OS version of the mobile device.

• AppViewName string optional

  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

• IndvId int optional

  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.

• Created timestamp optional

  The time that this user had their first session recorded by Fullstory.

• Uid string optional

  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.

• DisplayName string optional

  The display name that was set via FS.identify() or FS.setUserVars().

• Email string optional

  The email address that was set via FS.identify() or FS.setUserVars().

• NumSessions int optional

  The total number of sessions that have been recorded for this user.

• NumPages int optional

  The total number of pages that have been visited by this user.

• NumEvents int optional

  The total number of events associated with this user.

• TotalSec int optional

  The total length of time in seconds of the user's recorded sessions.

• ActiveSec int optional

  The total active time in seconds for the user's recorded sessions.

• AvgSessionSec int optional

  The average length of time of the user's sessions.

• AvgSessionActiveSec int optional

  The average active time of the user's sessions.

• MaxSessionSec int optional

  The longest session time for the user.

• LastSessionNumPages int optional

  The number of pages visited in the user's last session.

• LastSessionNumEvents int optional

  The number of events in the user's last session.

• LastSessionSec int optional

  The time in seconds of the user's last session.

• LastSessionActiveSec int optional

  The active time in seconds of the user's last session.

• LastSessionStart timestamp optional

  When the most recent session for this user started.

• LastPage string optional

  The last page that the user visited.

• LastIp string optional

  The IP address for the user's most recent session.

• LastLatLong string optional

  The latitude and longitude for the user's most recent session.

• LastEventStart timestamp optional

  The time for the last event in the user's most recent session.

• LastBrowser string optional

  The browser for the user's most recent session.

• LastDevice string optional

  The device for the user's most recent session.

• LastPlatform string optional

  The platform for the user's most recent session.

• LastOperatingSystem string optional

  The OS for the user's most recent session.

---

Additional Information

• Event Types
• Event Sub Types