Generate Context

Return the set of events for the specified session formatted for input into a Generative AI. The format and contents of the response are controlled by the Context specified to optimize the information included for the intended use case.

Early Access: This functionality is under active development. Documentation may be incomplete and is subject to change. Contact your Fullstory account team to request early access and provide feedback.

This functionality is available as a part of Data Direct and will soon be included as a part of Fullstory Anywhere.

To learn more about upcoming changes to Fullstory's product offerings, please visit this page.

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.

Request Body required

slice object optional

mode remove earliest or latest events as defined optional

Possible values: [UNSPECIFIED, FIRST, LAST, TIMESTAMP]

Default value: FIRST

event_limit int32 optional

duration_limit_ms int64 optional

start_timestamp date-time optional

If specified, the event limit and duration limit will be applied to the time beginning at this timestamp.

context object optional
include string[] optional
Controls the session context elements to include, takes precedence over individual inclusion fields. Can be 'user', 'org', 'location', 'device'. If not specified and not excluded, all context elements are included.
exclude string[] optional
Controls the session context elements to exclude, takes precedence over individual exclusion fields. Can be 'user', 'org', 'location', 'device'. If not specified and not excluded, all context elements are included.
exclude_org_context boolean optional
exclude_user_context boolean optional
exclude_location boolean optional
exclude_device boolean optional
exclude_descriptions boolean optional
events object optional
exclude_types string[] optional
include_types string[] optional
exclude_defined_events boolean optional
exclude_api_events boolean optional
exclude_event_timestamps boolean optional
exclude_selectors boolean optional
include_selector_tags boolean optional
trim_to_last_n_selectors int32 optional
media object optional
include_screenshots boolean optional
screenshot_event_types string[] optional
crop_screenshots_to_selector boolean optional
full_page_screenshots boolean optional
cache object optional
enable_event_cache boolean optional

Responses

200

---

Context response containing the session information and events as JSON.

Schema

Example

---

Schema

context_data object optional
context object optional
session_id string optional
session_url string optional
org_context object optional
org_id string optional
name string optional
industry string optional
domain string optional
country string optional
user_context object optional
user_uid string optional
display_name string optional
email string optional
properties object optional
property name* string optional
location_context object optional
country string optional
region string optional
city string optional
device_context object optional
browser string optional
operating_system string optional
screen_size object optional
height_pixels int32 optional
width_pixels int32 optional
viewport_size object optional
height_pixels int32 optional
width_pixels int32 optional
session_created_at date-time optional
pages object[] optional
Array [
url string optional
events object[] optional
Array [
type string optional
description string optional
timestamp date-time optional
screenshot_url string optional
content string optional
properties object optional
]
]

{
  "context_data": {
    "context": {
      "org_context": {},
      "user_context": {
        "properties": {}
      },
      "location_context": {},
      "device_context": {
        "screen_size": {},
        "viewport_size": {}
      }
    },
    "pages": [
      {
        "events": [
          {
            "properties": {}
          }
        ]
      }
    ]
  }
}

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