Skip to content

fix(replay): Document searchable properties screen and alias screens #14603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 11, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 20 additions & 14 deletions docs/concepts/search/searchable-properties/session-replay.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Replay activity is calculated based on the number of errors, the number of ui ev

### `browser.name`

Name of the users' web browser. For example, `Chrome`, `Firefox`, or `Safari`
Name of the users' web browser. For example, `Chrome`, `Firefox`, or `Safari`.

- **Type:** string

Expand All @@ -34,13 +34,13 @@ The version string of the browser.

### `click.alt`

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" />`
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

### `click.class`

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

Expand All @@ -54,19 +54,19 @@ Note: This property requires that your project have [React component name captur

### `click.id`

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

### `click.label`

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

### `click.role`

The `role` of an element that was clicked. For example, `button` would match both `<button>Save</button>` and `<a role="button">Submit</a>`
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

Expand All @@ -78,25 +78,25 @@ An element identified using a subset of CSS selector syntax. For example, `#sect

### `click.tag`

The tag name of an element that was clicked. For example, `input` would match `<input name="username" />`
The tag name of an element that was clicked. For example, `input` would match `<input name="username" />`.

- **Type:** string

### `click.testid`

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

### `click.textContent`

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

### `click.title`

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

Expand Down Expand Up @@ -144,7 +144,7 @@ Similar to the `click.selector` search property, but only queries on [dead click

### `device.brand`

Brand of the device
Brand of the device.

- **Type:** string

Expand All @@ -162,7 +162,7 @@ Internal hardware revision to identify the device exactly.

### `device.name`

Details of the device
Details of the device.

- **Type:** string

Expand Down Expand Up @@ -204,7 +204,7 @@ Severity of the event (such as: fatal, error, warning). Always set to info for t

### `os.name`

The name of the operating system. For example, `Windows`, `Mac OS X`, or `Linux`
The name of the operating system. For example, `Windows`, `Mac OS X`, or `Linux`.

- **Type:** string

Expand Down Expand Up @@ -244,6 +244,11 @@ The reason a replay was triggered. For example, `session` when `replaysSessionSa

- **Type:** string

### `screen`

A specific Screen or View that the user visited during the replay. You can also search for multiple Screens at once using `screens` and passing in an array of strings.
Alias: `url`

### `sdk.name`

Name of the Sentry SDK that sent the event.
Expand Down Expand Up @@ -272,6 +277,7 @@ A trace represents the record of the entire operation you want to measure or tra
### `url`

A specific URL that the user visited during the replay. You can also search for multiple URLs at once using `urls` and passing in an array of strings.
Alias: `screen`

- **Type:** string

Expand Down Expand Up @@ -301,7 +307,7 @@ Full name of the country of the user's geolocation.

### `user.geo.subdivision`

Full name of the subdivision of the user's geolocation. (For example, state, province, etc.)
Full name of the subdivision of the user's geolocation. (For example, state, province, etc.).

- **Type:** string

Expand Down