Download a Data Export bundle

You can download a collection of session events for your own analysis using FullStory's Data Export feature.

The get endpoint allows you to download a specific data export bundle given its ID. Our servers will respond with the bytes composing a gzipped JSON document of the request data.

If your client obeys the Content-Disposition header, then the downloaded file will automatically be called DataExport.json.gz. Otherwise, simply ensure that the response is treated as a gzip.

Data Export is an Enterprise pricing tier add-on. See pricing page for more details.

Method: GET

URI: /api/v1/export/get

Parameters

NameDescription
idThe id of the data export bundle to download, which was found from the response to a prior LIST request.

Request Headers

Authorization: Basic {YOUR_API_KEY}

Status Codes

200: Data Export file sent in the body

429: Too many requests received from the client (see Limits)

Limits

  • This endpoint is rate limited at 2 downloads/minute. Any additional requests over this limit will return an HTTP 429 status as well as the number of seconds to wait until the next request in the Retry-After header.

Data Dictionary

EventCustomName

string

The name of the event, if it is a custom event. The EventType field will have "custom" as it's value as well for custom events.

EventModDead

int

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

EventModError

int

Your customer clicked something and a console error was generated, either by an actual error occurring, or by logging an error to the console. Will be 1 for error clicks, zero for non-error clicks.

EventModFrustrated

int

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.

EventModSuspicious

int

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.

EventStart

string (dateTime)

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.

EventTargetText

string

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.

EventTargetSelectorTok

string

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.

Most non-alphanumeric characters within a selector will be encoded, e.g. “.my%2Dclass” rather than “.my-class”.

EventType

string

The type of event that was recorded. Typical types are:

abandon

A form was abandoned. Learn more about form abandonment.

change

The text in a text entry field was changed. The Event Target Text field will contain the new text value.

click

An element on the page has been clicked. The Event Target Text field will contain text of the clicked element, if applicable.

custom

A custom event, created by a call to FS.event.

Custom event fields in Data Export are a "flattened-out" representation of the JSON object passed into FS.event with an "evt" prefixed to the root JSON field names.

For example:

FS.event('Experiment', {
  campaign: {
    id_str: "16476490272",
    name_str: "Summer Promotion"
  },
  experiment: {
    id_str: "16448670971",
    name_str: "Landing Page Carousel vs. Featured Products Grid"
  }
});

Will be exported as:

"evt_campaign.id_str": "16476490272",
"evt_campaign.name_str": "Landing Page Carousel vs. Featured Products Grid",
"evt_experiment.id_str": "16448670971",
"evt_experiment.name_str": "Landing Page Carousel vs. Featured Products Grid",
load

A page was loaded from the server. This may have a matching "navigate" event.

navigate

A URL change, either to a completely new page or a new hash fragment. Changes to the window.history object (in a single page app) will also emit navigate events.

request

An XHR request was initatied from the browser.

seen

A watched element was visible in the browser.

thrash

The user moved the mouse cursor erratically or in circles. Learn more about thrashed cursors.

uservar

A call to FS.identify or FS.setUserVars was made. The custom user variables object passed into either function will be treated as individual fields in the response.

For example:

FS.indentify('123', { status_str: "gold" });

// or

FS.setUserVars({ status_str: "gold" });

Will be exported as:

status_str: "gold"

IndvId

int

A unique identifier for the Individual that combines all Users with the same User App Key. For example, f you’ve identified user 123 whenever they visit your site, their Individual will include all of their Sessions across devices, browsers, etc. The IndvdId value is not visible within the FullStory UI, but it is part of the session URL.

LoadDomContentTime

int

DOMContentLoaded fires when the initial HTML document has been loaded and parsed. Often this milestone occurs before stylesheets, images, and subframes finish loading, so the DOMContentLoaded event occurs before a page is done painting.

LoadEventTime

int

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.

LoadFirstPaintTime

int

The First Meaningful Paint event relates to the moment when the biggest "above-the-fold" layout change has happened and when web fonts have loaded. We believe that this metric relates most closely to a user's experience in terms of perceiving a page to be "loaded".

PageActiveDuration

int

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.

PageAgent

string

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

PageBrowser

string

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

Current possible values:

  • Chrome
  • Firefox
  • Internet Explorer
  • Microsoft Edge
  • Mobile App
  • Opera
  • Safari
  • Yandex
  • Robot
  • Unknown

New values may be added to this list at a later date.

PageClusterId

int

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

PageDevice

string

The device type that was used for this session, as derived from the User Agent.

Current possible values:

  • Desktop
  • Mobile
  • Tablet
  • Robot
  • Unknown

New values may be added to this list at a later date.

PageDuration

int

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.

PageId

int

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.

PageIp

string

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

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.

PageNumErrors

int

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.

PageNumInfos

int

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

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.

PageOperatingSystem

string

The operating system type that was used for this session, as derived from the User Agent.

Current possible values:

  • Android
  • Chrome OS
  • Linux
  • iOS
  • OS X
  • Windows
  • Windows Phone
  • Robot
  • Unknown

New values may be added to this list at a later date.

PageRefererUrl

string

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.

PageURL

string

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

SessionId

int

The identifier for a particular session, within the context of a single user.

Use Session Id and User Id together as a compound key to uniquely identify sessions across all export data.

UserAppKey

string

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.

UserEmail

string

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

UserDisplayName

string

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

UserId

int

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.

Additional Information