Skip to content

Commit d7f94be

Browse files
authored
fix(replay): Document searchable properties screen and alias screens (#14603)
See the results on `/concepts/search/searchable-properties/session-replay/` Fixes REPLAY-593
1 parent 7863d47 commit d7f94be

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

docs/concepts/search/searchable-properties/session-replay.mdx

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Replay activity is calculated based on the number of errors, the number of ui ev
2222

2323
### `browser.name`
2424

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

2727
- **Type:** string
2828

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

3535
### `click.alt`
3636

37-
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" />`
37+
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" />`.
3838

3939
- **Type:** string
4040

4141
### `click.class`
4242

43-
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>`
43+
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>`.
4444

4545
- **Type:** string
4646

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

5555
### `click.id`
5656

57-
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>`
57+
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>`.
5858

5959
- **Type:** string
6060

6161
### `click.label`
6262

63-
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>`
63+
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>`.
6464

6565
- **Type:** string
6666

6767
### `click.role`
6868

69-
The `role` of an element that was clicked. For example, `button` would match both `<button>Save</button>` and `<a role="button">Submit</a>`
69+
The `role` of an element that was clicked. For example, `button` would match both `<button>Save</button>` and `<a role="button">Submit</a>`.
7070

7171
- **Type:** string
7272

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

7979
### `click.tag`
8080

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

8383
- **Type:** string
8484

8585
### `click.testid`
8686

87-
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>`
87+
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>`.
8888

8989
- **Type:** string
9090

9191
### `click.textContent`
9292

93-
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>`
93+
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>`.
9494

9595
- **Type:** string
9696

9797
### `click.title`
9898

99-
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>`
99+
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>`.
100100

101101
- **Type:** string
102102

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

145145
### `device.brand`
146146

147-
Brand of the device
147+
Brand of the device.
148148

149149
- **Type:** string
150150

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

163163
### `device.name`
164164

165-
Details of the device
165+
Details of the device.
166166

167167
- **Type:** string
168168

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

205205
### `os.name`
206206

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

209209
- **Type:** string
210210

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

245245
- **Type:** string
246246

247+
### `screen`
248+
249+
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.
250+
Alias: `url`
251+
247252
### `sdk.name`
248253

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

274279
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.
280+
Alias: `screen`
275281

276282
- **Type:** string
277283

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

302308
### `user.geo.subdivision`
303309

304-
Full name of the subdivision of the user's geolocation. (For example, state, province, etc.)
310+
Full name of the subdivision of the user's geolocation. (For example, state, province, etc.).
305311

306312
- **Type:** string
307313

0 commit comments

Comments
 (0)