Get Export Results

Gets the results for a scheduled export.

Method: GET

URI: /search/v1/exports/{id}/results

Parameters

NameTypeDescription
idstringThe ID as returned from the Operations API results field

Request Headers

Authorization: Basic {YOUR_API_KEY}

Status Codes

200: A successful response.

Response Fields

NameTypeDescription
locationstringURL that should be used with an HTTP GET request to download the exported data.
expirestimestampUTC RFC 3339 timestamp indicating when the url in the location field will no longer be usable.

Downloading an export

This endpoint returns an URL that can be temporarily used to download the exported data. You can use curl to get the results from this URL:

curl -JO "<location url provided in response>"

This will save the export to the name provided in the Content-Disposition header, which is based on the name of the segment and the date that the export was created.


Event Export Fields

IndvId

int

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

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.

SessionId

int

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.

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.

UserCreated

timestamp

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

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.

UserDisplayName

string

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

UserEmail

string

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

EventStart

timestamp

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

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"

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.

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.

EventTargetSelector

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.

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.

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.

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.

EventVarErrorKind

string

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

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

SessionStart

timestamp

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.

PageStart

timestamp

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.

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.

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.

PageUrl

string

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

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.

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.

PageUserAgent

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.

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.

PagePlatform

string

The platform that was used for this session.

Current possible value:

  • Web
  • Native Mobile

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.

PageScreenWidth

int

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

PageScreenHeight

int

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

PageViewportWidth

int

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

PageViewportHeight

int

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

PageNumEvents

int

The total number of events that occurred on the page.

PageNumDerivedEvents

int

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

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.

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.

PageClusterId

int

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

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 Contentful 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".


Additional Fields for Accounts with Mobile Apps Features

AppName

string

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

AppPackageName

string

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


Individual Export Fields

IndvId

int

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 IndvdId value is not visible within the FullStory UI, but it is part of the session URL.

Created

timestamp

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

Uid

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.

DisplayName

string

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

Email

string

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

NumSessions

int

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

NumPages

int

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

NumEvents

#####int The total number of events associated with this user.

TotalSec

int

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

ActiveSec

int

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

AvgSessionSec

int

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

AvgSessionsActiveSec

int

The average active time of the user's sessions.

MaxSessionSec

int

The longest session time for the user.

LastSessionNumPages

int

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

LastSessionNumEvents

int

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

LastSessionSec

int

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

LastSessionActiveSec

int

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

LastSessionStart

timestamp

When the most recent session for this user started.

LastPage

string

The last page that the user visited.

LastIp

string

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

LastLatLong

string

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

LastEventStart

timestamp

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

LastBrowser

string

The browser for the user's most recent session.

LastDevice

string

The device for the user's most recent session.

LastPlatform

string

The platform for the user's most recent session.

LastOperatingSystem

string

The OS for the user's most recent session

Additionally, any user variables set with FS.identify() or FS.setUserVars() will be included in the export.

Additional Information