Get Profile

Return the summarization 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.

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

id string required

Client defined ID representing this profile to be used in profile management API calls and to specify when performing session analysis.

Responses

200

---

A successful response.

Schema

Example

---

Schema

id string optional

Client defined ID representing this profile to be used in profile management API calls and to specify when performing session analysis.

configuration object optional
Configuration used to customize session context presented to Generative AI for analysis.
exclude_selectors boolean optional
exclude_org_context boolean optional
exclude_user_context boolean optional
exclude_location boolean optional
exclude_device boolean optional
exclude_defined_events boolean optional
exclude_event_timestamps boolean optional
trim_to_last_n_selectors int32 optional
exclude_event_types string[] optional
include_event_types string[] optional
exclude_display_elements boolean optional
exclude_api_events boolean optional
include_screenshots boolean optional
screenshot_event_types string[] optional
crop_screenshots_to_selector boolean optional
include_tree_snapshots boolean optional
exclude_descriptions boolean optional
full_page_screenshots boolean optional
enable_event_cache boolean optional
filter_options object optional
truncate_mode remove earliest or latest events as defined optional
Possible values: [TRUNCATE_MODE_UNSPECIFIED, TRUNCATE_MODE_START, TRUNCATE_MODE_END]
Default value: TRUNCATE_MODE_UNSPECIFIED
truncate_event_limit int32 optional
truncate_time_milliseconds_limit int64 optional
pre_prompt string optional

Text to be included in the Generative AI prompt before including the contextual representation of the requested session.

post_prompt string optional

Text to be included in the Generative AI prompt before including the contextual representation of the requested session.

output_schema Optional JSON Schema to define output optional

JSON schema to provide to Generative AI for formatting of result and to be used to validate the proper output format.

model string optional

Possible values: [GEMINI_2_FLASH, GEMINI_2_FLASH_LITE]

Generative AI large language model to use.

temperature float optional

Controls the randomness of text generated by a large language model.

{
  "configuration": {
    "exclude_event_types": [
      null
    ],
    "include_event_types": [
      null
    ],
    "screenshot_event_types": [
      null
    ],
    "filter_options": {
      "truncate_mode": "TRUNCATE_MODE_UNSPECIFIED"
    }
  },
  "model": "INVALID"
}

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