Generate Summary

Return a Generative AI summarization of the specified session using the supplied Profile that specifies both prompting instructions and session context configuration.

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.

Available for Fullstory customers who have purchased Data Direct.

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.

Query Parameters

config_profile string optional

Responses

200

---

Text based output of the Generative AI response based on the specified Profile.

Schema

Example

---

Schema

summary string optional

{}

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"
}

GET /v2beta/sessions/{session_id}/summary

Authorization: ApiKeyAuth

name: Authorizationin: headertype: apiKey

https://api.fullstory.com/v2beta/sessions/{session_id}/summary

cURL

curl -L -X GET 'https://api.fullstory.com/v2beta/sessions/:session_id/summary' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'

Python

curl -L -X GET 'https://api.fullstory.com/v2beta/sessions/:session_id/summary' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'

Go

curl -L -X GET 'https://api.fullstory.com/v2beta/sessions/:session_id/summary' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'

Javascript

curl -L -X GET 'https://api.fullstory.com/v2beta/sessions/:session_id/summary' \
-H 'Accept: application/json' \
-H 'Authorization: Basic <API_KEY_VALUE>'