Ask A BotSession Replay Properties
Session Replay provides a video-like reproduction of user interactions on a site or web app. All user interactions, including page visits, mouse movements, clicks, and scrolls, are captured, helping developers connect the dots between a known issue and how a user experienced it in the UI.
You can search by session replay properties on the Replay page.
Below is a list of keys and tokens that can be used in the session replay search.
Replay activity is calculated based on the number of errors, the number of ui events, and the duration of the replay. It's represented as a number from 1 to 10.
- Type: number
Name of the users' web browser. For example, Chrome, Firefox, or Safari
- Type: string
The version string of the browser.
- Type: string
The alt of an element that was clicked. For example, "a good dog" would match the element <img src="/lassie.jpeg" alt="a good dog" />
- Type: string
The class of an element that was clicked. No leading . is necessary. For example, btn-primary would match the element <a class="btn btn-primary">Save</a>
- Type: string
The name of the frontend component that was clicked. For example, MyAwesomeComponent would match the React component <MyAwesomeComponent>.
Note: This property requires that your project have React component name capturing configured.
- Type: string
The id of an element that was clicked. No leading # is necessary. For example, reset-password would match the element <a id="reset-password">Reset</a>
- Type: string
The aria-label of an element that was clicked. For example, Expand would match the element <button aria-label="Expand"><img src="/icons/expand.png"/></button>
- Type: string
The role of an element that was clicked. For example, button would match both <button>Save</button> and <a role="button">Submit</a>
- Type: string
An element identified using a subset of CSS selector syntax. For example, #section-1 or span.active or span[role=button] or .active[role=button] would all match the element <span id="section-1" class="active" role="button"/>. Note that, CSS combinators, pseudo selectors, and attr selectors other than = are not supported.
- Type: string
The tag name of an element that was clicked. For example, input would match <input name="username" />
- Type: string
The data-testid or data-test-id of an element that was clicked. For example, user-name would match the element <a data-testid="user-name">User Name</a>
- Type: string
The immediate textContent of an element that was clicked. For example, Save would match <button>Save</button> but wouldn't match <button><h1>Save</h1></button>
- Type: string
The title of an element that was clicked. For example, Save this comment would match the element <a title="Save this comment" class="btn btn-primary">Save</a>
- Type: string
The number of dead clicks within a replay.
- Type: number
The number of errors within a replay.
- Type: number
The number of rage clicks within a replay.
- Type: number
The number of segments within a replay. More segments represent more activity over time.
- Type: number
The number of URLs that the user visited during a replay recording.
- Type: number
Similar to the click.selector search property, but only queries on dead clicks. An element identified using a subset of CSS selector syntax. For example, #section-1 or span.active or span[role=button] or .active[role=button] would all match the element <span id="section-1" class="active" role="button"/>. Note that, CSS combinators, pseudo selectors, and attr selectors other than = are not supported.
- Type: string
Brand of the device
- Type: string
Family of the device. Typically, the common part of a model name across generations. For example, iPhone, Samsung Galaxy.
- Type: string
Internal hardware revision to identify the device exactly.
- Type: n/a
Details of the device
- Type: string
Distinguishes build or deployment variants of the same release of an application. For example, the dist can be the build number of an Xcode build or the version code of an Android build.
- Type: string
Duration of a replay in seconds.
- Type: number
Error instances that have occurred within a replay.
- Type: array
The event or replay id. In Issues, use only the ID value without the id key.
- Type: UUID
Severity of the event (such as: fatal, error, warning). Always set to info for transactions.
- Type: string
The name of the operating system. For example, Windows, Mac OS X, or Linux
- Type: string
The version number of the operating system.
- Type: string
Name of the platform. This is only a metrics property for valid platforms, defaulting to other.
- Type: string
The id of the project.
- Type: string
Similar to the click.selector search property, but only queries on rage clicks. An element identified using a subset of CSS selector syntax. For example, #section-1 or span.active or span[role=button] or .active[role=button] would all match the element <span id="section-1" class="active" role="button"/>. Note that, CSS combinators, pseudo selectors, and attr selectors other than = are not supported.
- Type: string
A release is a version of your code deployed to an environment. You can create a token with an exact match of the version of a release, or release:latest to pick the most recent release.
- Type: string
The reason a replay was triggered. For example, session when replaysSessionSampleRate takes effect, or error when replaysOnErrorSampleRate is sampled instead of session.
- Type: string
Name of the Sentry SDK that sent the event.
- Type: string
Version of the Sentry SDK that sent the event.
- Type: string
Sentry user IDs who have seen this Replay. Alias: viewed_by_id
- Type: number
A trace represents the record of the entire operation you want to measure or track — like page load, searched using the UUID generated by Sentry’s SDK.
- Type: UUID
A specific URL that the user visited during the replay.
- Type: string
An alternative, or addition, to the username. Sentry is aware of email addresses and can therefore display things such as Gravatars and unlock messaging capabilities.
- Type: string
Application-specific internal identifier for the user.
- Type: string
User's IP address. Sentry uses the IP address as a unique identifier for unauthenticated users.
- Type: string
Username, which is typically a better label than the user.id.
- Type: string
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").