Get Session Events

Return the full set of captured events for a specified Session

Available for Fullstory customers who have purchased Data Direct. This API is still in Beta and is subject to change.

Path Parameters

session_id string required

The UTF-8 encoded ID of the session for which to generate context data. To retrieve the Session ID you may use the appropriate Get Session Details API for Web, iOS, or Android. As Session IDs include : separators the ID must be URL encoded using the %3A substitution.

Responses

200

---

A successful response.

Schema

Example

---

Schema

events object[] optional
JSON array of session events based on the Events model.
Array [
device_id int64 optional
The device ID indicates a unique recording device for the event. For web recording, the ID corresponds to a unique user cookie. For mobile recording, this corresponds to a single app/device combo. This field is always present.
session_id int64 optional
If present, indicates the session for the event.
view_id int64 optional
If present, indicates the view for the event. For web recording, this corresponds to a single page load. For mobile recording, this corresponds to a continuous period of recording.
event_time date-time optional
The timestamp for when the event was occurred.
event_type string optional
The type of the event.
event_properties object optional
Details about the event.
navigate object optional
navigate_reason string optional
fs_suspicious_kind string[] optional
Indicates any suspicious activity detected in the navigate event.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
load object optional
dom_content_time_millis int64 optional
The time it took for the document to be parsed and the DOM tree to be constructed.
first_paint_time_millis int64 optional
The time of the First Contentful Paint (FCP).
load_time_millis int64 optional
The time it took for the page to load completely.
largest_paint_time_millis int64 optional
The time of the Largest Contentful Paint (LCP).
time_to_interactive_millis int64 optional
The Time to Interactive (TTI) is the time it takes for the page to become fully interactive.
total_blocking_time_millis int64 optional
The Total Blocking Time (TBT) is the total amount of time that the page was blocked after the FCP.
time_to_first_byte_millis int64 optional
The Time to First Byte (TTFB) is the time it takes for the first byte of the response to be received.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
click object optional
target object optional
The target of the click event.
raw_selector string optional
The full selector path to the event's target element.
text string optional
The relevant text of the event's target element, such as inner text for click events and values for input change events.
masked boolean optional
If true, indicates that the target text is empty because it was masked due to a privacy rule.
element_definition_id string optional
The ID of the most specific, matching user-configured Named Element.
additional_element_definition_ids string[] optional
Additional matching Named Element IDs.
element_properties object optional
Properties extracted from configured attributes on the target element.
fs_rage_count int64 optional
If greater than 0, indicates that the click was part of a rage click sequence. Learn more.
fs_dead_count int64 optional
This value will be 1 if the click did not have an effect on the page, thus is considered dead. Learn more.
fs_error_kind string optional
If present, indicates an error click. Learn more.
is_click_long boolean optional
If true, indicates that the click was a long click. Only available on mobile.
is_click_unhandled boolean optional
If true, indicates that the click was unhandled. Only available on mobile.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
change object optional
target object optional
The target of the change event.
raw_selector string optional
The full selector path to the event's target element.
text string optional
The relevant text of the event's target element, such as inner text for click events and values for input change events.
masked boolean optional
If true, indicates that the target text is empty because it was masked due to a privacy rule.
element_definition_id string optional
The ID of the most specific, matching user-configured Named Element.
additional_element_definition_ids string[] optional
Additional matching Named Element IDs.
element_properties object optional
Properties extracted from configured attributes on the target element.
fs_suspicious_kind string[] optional
Indicates any suspicious activity detected in the change event.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
tap object optional
target object optional
raw_selector string optional
The full selector path to the event's target element.
text string optional
The relevant text of the event's target element, such as inner text for click events and values for input change events.
masked boolean optional
If true, indicates that the target text is empty because it was masked due to a privacy rule.
element_definition_id string optional
The ID of the most specific, matching user-configured Named Element.
additional_element_definition_ids string[] optional
Additional matching Named Element IDs.
element_properties object optional
Properties extracted from configured attributes on the target element.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
mouse_thrash object optional
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
form_abandon object optional
target object optional
The target indicates the form that was abandoned.
raw_selector string optional
The full selector path to the event's target element.
text string optional
The relevant text of the event's target element, such as inner text for click events and values for input change events.
masked boolean optional
If true, indicates that the target text is empty because it was masked due to a privacy rule.
element_definition_id string optional
The ID of the most specific, matching user-configured Named Element.
additional_element_definition_ids string[] optional
Additional matching Named Element IDs.
element_properties object optional
Properties extracted from configured attributes on the target element.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
element_seen object optional
element_type string optional
element_render_duration_millis int64 optional
The amount of time that the element was rendered.
element_visible_duration_millis int64 optional
The amount of time that the element was visible.
element_start_type string optional
The type of the Watched Element at the element_start_time.
element_start_time int64 optional
The time at which the Watched Element was first rendered or made visible.
target object optional
The watched element target.
raw_selector string optional
The full selector path to the event's target element.
text string optional
The relevant text of the event's target element, such as inner text for click events and values for input change events.
masked boolean optional
If true, indicates that the target text is empty because it was masked due to a privacy rule.
element_definition_id string optional
The ID of the most specific, matching user-configured Named Element.
additional_element_definition_ids string[] optional
Additional matching Named Element IDs.
element_properties object optional
Properties extracted from configured attributes on the target element.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
request object optional
request_method string optional
The HTTP request method (GET, POST, etc).
request_url object optional
The request URL.
full_url string optional
A full URL including the protocol, host, path, query, and hash.
host string optional
The host portion of the URL. e.g. www.example.com.
path string optional
The path portion of the URL. e.g. /path/to/page.
query object optional
The query portion of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, /path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
hash_path string optional
The hash path of the URL. e.g. #/path/to/page would be represented as /path/to/page.
hash_query object optional
The hash query of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, #/path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
request_status int32 optional
The HTTP status code of the request.
request_duration_millis int64 optional
The duration of the request.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
background object optional
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
crash object optional
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
custom object optional
event_name string optional
The name of the custom event as provided by the API.
event_properties object optional
An object containing the parsed payload of the custom event.
fs_api_errors object[] optional
Any errors that occurred while processing the custom event.
Array [
reason string optional
The reason for the error.
field string optional
If present, the name/key of the field that is invalid.
value string optional
If present, the json representation of the invalid value.
]
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
identify object optional
user_id string optional
The unique ID for the user provided through the API.
user_email string optional
If present, the email address for the user.
user_display_name string optional
The display name for the user as provided through the API. If none is provided, this will be generated by the Fullstory backend.
user_properties object optional
An object containing the parsed payload of the user properties provided through the API.
fs_api_errors object[] optional
Any errors that occurred while processing the user properties.
Array [
reason string optional
The reason for the error.
field string optional
If present, the name/key of the field that is invalid.
value string optional
If present, the json representation of the invalid value.
]
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
redact object optional
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
detection object optional
detection_type string optional
Specifies the type of data discovered (payment card, email, etc).
detection_source string optional
Specifies the source of the data (navigation url, element, etc).
detection_origin string optional
Source-specific value that gives extra detail on the data origin.
detection_request_url object optional
For network request sources, specifies the associated request url. For log / exception sources, specifies the source file url.
full_url string optional
A full URL including the protocol, host, path, query, and hash.
host string optional
The host portion of the URL. e.g. www.example.com.
path string optional
The path portion of the URL. e.g. /path/to/page.
query object optional
The query portion of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, /path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
hash_path string optional
The hash path of the URL. e.g. #/path/to/page would be represented as /path/to/page.
hash_query object optional
The hash query of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, #/path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
target object optional
raw_selector string optional
The full selector path to the event's target element.
text string optional
The relevant text of the event's target element, such as inner text for click events and values for input change events.
masked boolean optional
If true, indicates that the target text is empty because it was masked due to a privacy rule.
element_definition_id string optional
The ID of the most specific, matching user-configured Named Element.
additional_element_definition_ids string[] optional
Additional matching Named Element IDs.
element_properties object optional
Properties extracted from configured attributes on the target element.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
keyboard_open object optional
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
keyboard_close object optional
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
low_memory object optional
memory_available int64 optional
The amount of memory available on the device at the time of the event.
memory_maximum int64 optional
The maximum amount of memory available on the device.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
page_properties object optional
page_name string optional
The name of the page as provided through the API.
page_properties object optional
An object containing the parsed payload of the page properties provided through the API.
fs_api_errors object[] optional
Any errors that occurred while processing the page properties.
Array [
reason string optional
The reason for the error.
field string optional
If present, the name/key of the field that is invalid.
value string optional
If present, the json representation of the invalid value.
]
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
pinch_gesture object optional
pinch_gesture_type string optional
pinch_visual_scale_change double optional
The change in the visual viewport after a finger pinch. If the change > 1.0, it implies scale in. If the change < 1.0, it implies scale out. If the change is exactly 1.0, it means a failed finger pinch.
pinch_scale double optional
Scale determines the overall page scale at the end of the pinch. It is the ratio of the layout viewport dimensions to visual viewport dimensions. When the page is scaled out to max, the scale is 1.0 and greater than 1.0 otherwise.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
exception object optional
exception_source_file string optional
The source file that produced the exception.
exception_count int32 optional
The number of times that this exception fired within a given window (useful for batching bursts of exceptions fired).
is_exception_handled boolean optional
Whether the exception is caught or not.
message string optional
The message associated with the exception.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
highlight object optional
target object optional
The target of the highlight event. The text field indicates the highlighted text.
raw_selector string optional
The full selector path to the event's target element.
text string optional
The relevant text of the event's target element, such as inner text for click events and values for input change events.
masked boolean optional
If true, indicates that the target text is empty because it was masked due to a privacy rule.
element_definition_id string optional
The ID of the most specific, matching user-configured Named Element.
additional_element_definition_ids string[] optional
Additional matching Named Element IDs.
element_properties object optional
Properties extracted from configured attributes on the target element.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
copy object optional
target object optional
The target of the copy event. The text field indicates the copied text.
raw_selector string optional
The full selector path to the event's target element.
text string optional
The relevant text of the event's target element, such as inner text for click events and values for input change events.
masked boolean optional
If true, indicates that the target text is empty because it was masked due to a privacy rule.
element_definition_id string optional
The ID of the most specific, matching user-configured Named Element.
additional_element_definition_ids string[] optional
Additional matching Named Element IDs.
element_properties object optional
Properties extracted from configured attributes on the target element.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
paste object optional
target object optional
The target of the past event. The 'text' field indicates the pasted text.
raw_selector string optional
The full selector path to the event's target element.
text string optional
The relevant text of the event's target element, such as inner text for click events and values for input change events.
masked boolean optional
If true, indicates that the target text is empty because it was masked due to a privacy rule.
element_definition_id string optional
The ID of the most specific, matching user-configured Named Element.
additional_element_definition_ids string[] optional
Additional matching Named Element IDs.
element_properties object optional
Properties extracted from configured attributes on the target element.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
console_message object optional
console_message_level string optional
The level that the console message was logged at.
message string optional
The text of the console message.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
consent object optional
is_consent_given boolean optional
If true, then a user has consented to capture elements that require consent.
consent_scope string optional
The scope of the provided consent.
consent_action_type string optional
Indicates how this consent event was added during capture.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
rate_limit object optional
rate_limit_event_type string optional
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
first_input_delay object optional
first_input_delay_millis int64 optional
The time from the first user input event to the browser's response.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
cumulative_layout_shift object optional
cumulative_layout_shift double optional
The Cumulative Layout Shift (CLS) score for the page.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
keep object optional
type string optional
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
page_view object optional
start_time int64 optional
end_time int64 optional
page_name string optional
duration_millis int64 optional
active_duration_millis int64 optional
inactive_duration_millis int64 optional
fs_suspicious_kind string[] optional
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
app_forced_restart object optional
elapsed_millis uint64 optional
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
interaction_to_next_paint object optional
interaction_to_next_paint_millis int64 optional
The time from the first user input event to the next paint event.
event_name string optional
The name of the event that triggered the first user input as reported by the browser. Examples are: keydown and mouseover.
event_definition_id string optional
The ID of the most specific matching user-configured Defined Event.
additional_event_definition_ids string[] optional
Additional matching event definition IDs.
source_type string optional
The source type describes the type of technology that is the source of this event.
source_properties object optional
Details about the corresponding EventSource.
web object optional
user_agent object optional
The user agent of the browser that generated the event.
raw_user_agent string optional
An unprocessed user agent string. This value is used to derive the following fields. There may be cases where this string is not in a known format, in which case the derived fields will be either Unknown or null.
device string optional
If present, the type of device. Example values include: Tablet, Mobile, Desktop, Robot.
operating_system string optional
If present, the operating system of the device. Example values include: Windows, OS X, iOS, Android, and Linux.
browser string optional
The browser used by the device or Unknown. Example values include: Chrome, Safari, Firefox, Microsoft Edge, and Custom Agent.
browser_version string optional
If present, the version of the browser. This field will only be present if the version is of the format major.minor.build.patch where each subversion is optional (e.g. 10A is a valid version). Otherwise, this field will be null.
url object optional
The URL of the page when the event occurred.
full_url string optional
A full URL including the protocol, host, path, query, and hash.
host string optional
The host portion of the URL. e.g. www.example.com.
path string optional
The path portion of the URL. e.g. /path/to/page.
query object optional
The query portion of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, /path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
hash_path string optional
The hash path of the URL. e.g. #/path/to/page would be represented as /path/to/page.
hash_query object optional
The hash query of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, #/path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
initial_referrer object optional
The referrer from the the first navigation event in the "view".
full_url string optional
A full URL including the protocol, host, path, query, and hash.
host string optional
The host portion of the URL. e.g. www.example.com.
path string optional
The path portion of the URL. e.g. /path/to/page.
query object optional
The query portion of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, /path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
hash_path string optional
The hash path of the URL. e.g. #/path/to/page would be represented as /path/to/page.
hash_query object optional
The hash query of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, #/path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
entrypoint string optional
If present, indicates how the event was created, including from the Fullstory capture script. Some examples are: web client, setVars, event, and POST /v2/users. Support for this field not guaranteed across all capture clients.
origin string optional
If present, indicates where the event was generated. Some examples are: dom and server.
integration string optional
If present, indicates the integration that generated the event. For Fullstory built capture sources, this value will be fs. Examples include dlo, segment, and zendesk. Support fot this field is not guaranteed across all integrations.
page_definition_id string optional
The ID of the Page as defined in the FullStory app.
location object optional
The location associated with the capture of the event. Learn more.
ip_address string optional
If present, the IP address at the start of the associated capture instance. That is, this will be the same for all events with the same device_id, session_id, and view_id.
country string optional
If present, the country associated with the IP address.
region string optional
If present, the name of the region associated with the IP address.
city string optional
If present, the name of the city associated with the IP address.
lat_long string optional
If present, the latitude and longitude associated with the IP address. The format is "latitude,longitude".
device object optional
Information about the device associated with the event. For web events, similar information is available in the user_agent field.
manufacturer string optional
If present, the manufacturer of the device. Generally available for Mobile Apps, but may also be provided by the server API. Examples include: Apple, Samsung, Google, and Microsoft.
model string optional
If present, the model of the device. Generally available for Mobile Apps, but may also be provided by the server API. Examples include: iPhone12,5, Pixel 5, and Surface Pro 7 and SM-G950F.
operating_system string optional
If present, the operating system of the device. Generally available for Mobile Apps, but may also be provided by the server API.
os_version string optional
If present, the version of the operating system. Generally available for Mobile Apps, but may also be provided by the server API.
screen_height int32 optional
Indicates the screen height of the device in pixels.
screen_width int32 optional
Indicates the screen width of the device in pixels.
viewport_height int32 optional
Indicates the height of the viewport in pixels at the time of the event. Generally available for web sources, but may also be provided by the server API.
viewport_width int32 optional
Indicates the width of the viewport in pixels at the time of the event. Generally available for web sources, but may also be provided by the server API.
server object optional
user_agent object optional
raw_user_agent string optional
An unprocessed user agent string. This value is used to derive the following fields. There may be cases where this string is not in a known format, in which case the derived fields will be either Unknown or null.
device string optional
If present, the type of device. Example values include: Tablet, Mobile, Desktop, Robot.
operating_system string optional
If present, the operating system of the device. Example values include: Windows, OS X, iOS, Android, and Linux.
browser string optional
The browser used by the device or Unknown. Example values include: Chrome, Safari, Firefox, Microsoft Edge, and Custom Agent.
browser_version string optional
If present, the version of the browser. This field will only be present if the version is of the format major.minor.build.patch where each subversion is optional (e.g. 10A is a valid version). Otherwise, this field will be null.
url object optional
full_url string optional
A full URL including the protocol, host, path, query, and hash.
host string optional
The host portion of the URL. e.g. www.example.com.
path string optional
The path portion of the URL. e.g. /path/to/page.
query object optional
The query portion of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, /path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
hash_path string optional
The hash path of the URL. e.g. #/path/to/page would be represented as /path/to/page.
hash_query object optional
The hash query of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, #/path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
initial_referrer object optional
full_url string optional
A full URL including the protocol, host, path, query, and hash.
host string optional
The host portion of the URL. e.g. www.example.com.
path string optional
The path portion of the URL. e.g. /path/to/page.
query object optional
The query portion of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, /path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
hash_path string optional
The hash path of the URL. e.g. #/path/to/page would be represented as /path/to/page.
hash_query object optional
The hash query of the URL, structured as an object where the key is the query parameter name and the value is a list of values for that parameter. For example, #/path/to/page?foo=bar&baz=qux&baz=boop would be represented as { "foo": { "values": ["bar"] }, "baz": { "values": ["qux", "boop"] }}.
property name* object optional
values string[] optional
app_screen_name string optional
build_variant string optional
app_id string optional
app_name string optional
app_package_name string optional
app_version string optional
entrypoint string optional
If present, indicates how the event was created, including from the Fullstory capture script. Some examples are: web client, setVars, event, and POST /v2/users. Support for this field not guaranteed across all capture clients.
origin string optional
If present, indicates where the event was generated. Some examples are: dom and server.
integration string optional
If present, indicates the integration that generated the event. For Fullstory built capture sources, this value will be fs. Examples include dlo, segment, and zendesk. Support fot this field is not guaranteed across all integrations.
page_definition_id string optional
The ID of the Page as defined in the FullStory app.
location object optional
The location associated with the capture of the event. Learn more.
ip_address string optional
If present, the IP address at the start of the associated capture instance. That is, this will be the same for all events with the same device_id, session_id, and view_id.
country string optional
If present, the country associated with the IP address.
region string optional
If present, the name of the region associated with the IP address.
city string optional
If present, the name of the city associated with the IP address.
lat_long string optional
If present, the latitude and longitude associated with the IP address. The format is "latitude,longitude".
device object optional
Information about the device associated with the event. For web events, similar information is available in the user_agent field.
manufacturer string optional
If present, the manufacturer of the device. Generally available for Mobile Apps, but may also be provided by the server API. Examples include: Apple, Samsung, Google, and Microsoft.
model string optional
If present, the model of the device. Generally available for Mobile Apps, but may also be provided by the server API. Examples include: iPhone12,5, Pixel 5, and Surface Pro 7 and SM-G950F.
operating_system string optional
If present, the operating system of the device. Generally available for Mobile Apps, but may also be provided by the server API.
os_version string optional
If present, the version of the operating system. Generally available for Mobile Apps, but may also be provided by the server API.
screen_height int32 optional
Indicates the screen height of the device in pixels.
screen_width int32 optional
Indicates the screen width of the device in pixels.
viewport_height int32 optional
Indicates the height of the viewport in pixels at the time of the event. Generally available for web sources, but may also be provided by the server API.
viewport_width int32 optional
Indicates the width of the viewport in pixels at the time of the event. Generally available for web sources, but may also be provided by the server API.
mobile_app object optional
app_screen_name string optional
The name of the mobile app screen on which the event occurred.
build_variant string optional
Android build variant (e.g. debug, release).
app_id string optional
Identifies a run of FSCLI during iOS native mobile builds.
app_name string optional
The name of the mobile app that produced the event.
app_package_name string optional
Code-level package name of a mobile app, e.g. com.fullstory.sampleapp.latest.
app_version string optional
Mobile app version, e.g. 25.0.1.
entrypoint string optional
If present, indicates how the event was created, including from the Fullstory capture script. Some examples are: web client, setVars, event, and POST /v2/users. Support for this field not guaranteed across all capture clients.
origin string optional
If present, indicates where the event was generated. Some examples are: dom and server.
integration string optional
If present, indicates the integration that generated the event. For Fullstory built capture sources, this value will be fs. Examples include dlo, segment, and zendesk. Support fot this field is not guaranteed across all integrations.
page_definition_id string optional
The ID of the Page as defined in the FullStory app.
location object optional
The location associated with the capture of the event. Learn more.
ip_address string optional
If present, the IP address at the start of the associated capture instance. That is, this will be the same for all events with the same device_id, session_id, and view_id.
country string optional
If present, the country associated with the IP address.
region string optional
If present, the name of the region associated with the IP address.
city string optional
If present, the name of the city associated with the IP address.
lat_long string optional
If present, the latitude and longitude associated with the IP address. The format is "latitude,longitude".
device object optional
Information about the device associated with the event. For web events, similar information is available in the user_agent field.
manufacturer string optional
If present, the manufacturer of the device. Generally available for Mobile Apps, but may also be provided by the server API. Examples include: Apple, Samsung, Google, and Microsoft.
model string optional
If present, the model of the device. Generally available for Mobile Apps, but may also be provided by the server API. Examples include: iPhone12,5, Pixel 5, and Surface Pro 7 and SM-G950F.
operating_system string optional
If present, the operating system of the device. Generally available for Mobile Apps, but may also be provided by the server API.
os_version string optional
If present, the version of the operating system. Generally available for Mobile Apps, but may also be provided by the server API.
screen_height int32 optional
Indicates the screen height of the device in pixels.
screen_width int32 optional
Indicates the screen width of the device in pixels.
viewport_height int32 optional
Indicates the height of the viewport in pixels at the time of the event. Generally available for web sources, but may also be provided by the server API.
viewport_width int32 optional
Indicates the width of the viewport in pixels at the time of the event. Generally available for web sources, but may also be provided by the server API.
]

{
  "events": [
    {
      "deviceId": "17117",
      "sessionId": "5916567459329906423",
      "viewId": "4376064173749384629",
      "eventTime": "2024-04-03T17:06:12.290Z",
      "eventType": "navigate",
      "eventProperties": {
        "navigateReason": "navigate",
        "fsSuspiciousKind": [],
        "eventDefinitionId": "Navigate-Login-Event",
        "additionalEventDefinitionIds": []
      },
      "sourceType": "web",
      "sourceProperties": {
        "userAgent": {
          "rawUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36",
          "device": "Desktop",
          "operatingSystem": "OS X",
          "browser": "Chrome",
          "browserVersion": "123.0.0.0"
        },
        "url": {
          "fullUrl": "https://app.fullstory.com/login/?dest=%2Fui",
          "host": "app.fullstory.com",
          "path": "/login/",
          "query": {
            "dest": {
              "values": [
                "/ui"
              ]
            }
          },
          "hashPath": "",
          "hashQuery": {}
        },
        "initialReferrer": null
      }
    }
  ]
}

Returned when invalid input has been provided. Fix the issue and retry.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "session_id is required",
  "code": "required_field"
}

Returned when access to the resource is unauthorized.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "access is unauthorized",
  "code": "unauthorized"
}

Returned when access is not allowed due to insufficient permissions.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "insufficient permissions",
  "code": "forbidden"
}

Returned when the resource does not exist.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Requested resource does not exist",
  "code": "resource_not_found"
}

Returned when the client has exceeded the rate limit for this endpoint. A Retry-After header will be included with the response. This header will contain the number of seconds that you should wait before attempting to send another request.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
  "code": "too_many_requests"
}

Returned when a server error is encountered

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Server error was encountered",
  "code": "server_error"
}

Loading...