1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
- "Firefox :: Address Bar"
urlbar:
abandonment:
type: event
description: Recorded when the user abandons a search (blurring the urlbar).
extra_keys:
sap:
description: >
`sap` is the meaning of `search access point`. It records where the
user started the search action from. The possible values are: `urlbar`
, `handoff`, `urlbar_newtab` and `urlbar_addonpage`.
type: string
interaction:
description: >
How the user started the search action. The possible values are:
`typed`, `pasted`, `topsite_search` (clicked on a topsite search
shortcut), `topsites` (selected a topsite result with empty search
string), `returned` (The user abandoned a search, then returned to it)
, `restarted` (The user abandoned a search, then returned to it,
cleared it and typed a completely different string), `refined` (The
user abandoned a search, then returned to it, and partially modified
the string), `persisted_search_terms` (The user returned to a previous
successful search that persisted terms in the urlbar),
`persisted_search_terms_restarted` (The user returned to a previous
successful search that persisted terms in the urlbar, then cleared it
and typed a completely different string) and
`persisted_search_terms_refined` (The user returned to a previous
successful search that persisted terms in the urlbar, and partially
modified the string).
type: string
search_mode:
description: >
If the urlbar is in search mode, thus restricting results to a
specific search engine or local source, this is set to the search mode
source. The possible sources are: `actions`, `bookmarks`, `history`,
`search_engine`, and `tabs`. If search mode is active but the source
did not fall into any of these categories, this will be `unknown`. If
search mode is not active, this will be an empty string.
type: string
n_chars:
description: >
The length of string used for the search. It includes whitespaces.
type: quantity
n_words:
description: >
The length of words used for the search. The words are made by
splitting the search string by whitespaces, thus this doesn’t support
CJK languages. For performance reasons a maximum of 255 characters are
considered when splitting.
type: quantity
n_results:
description: >
The number of results shown to the user. If this is high the results
list below may be truncated due to technical limitations. Also note in
that case not all the results may be physically visible due to the
screen size limitation.
type: quantity
groups:
description: >
Comma separated list of result groups in the order they were shown to
the user. The groups may be repeated, since the list will match 1:1
the results list, so we can link each result to a group. The possible
group names are: `heuristic`, `adaptive_history`, `search_history`,
`search_suggest`, `top_pick`, `top_site`, `remote_tab`, `addon`,
`general`, `suggest`, `about_page` and `suggested_index`. If the group
did not fall into any of these, this will be `unknown` and a bug
should be filed to investigate it.
type: string
results:
description: >
Comma separated list of result types in the order they were shown to
the user. The possible result types are: `autofill_about`,
`autofill_adaptive`, `autofill_origin`, `autofill_url`,
`autofill_unknown`, `bookmark`, `history`, `keyword`, `search_engine`,
`search_suggest`, `search_history`, `url`, `action`, `tab`,
`remote_tab`, `addon`, `tip_onboard`, `tip_persist`, `tip_redirect`,
`tip_unknown`, `intervention_clear`, `intervention_refresh`,
`intervention_update`, `intervention_unknown`, `tab_to_search`,
`top_site`, `calc`, `unit`, `suggest_sponsor` and
`suggest_non_sponsor`. If the result type did not fall into any of
these, this will be `unknown` and a bug should be filed to investigate
it.
type: string
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1800414
- https://bugzilla.mozilla.org/show_bug.cgi?id=1805717
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1800414#c2
- https://bugzilla.mozilla.org/show_bug.cgi?id=1805717#c4
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
engagement:
type: event
description: Recorded when the user executes an action on a result.
extra_keys:
sap:
description: >
`sap` is the meaning of `search access point`. It records where the
user started the search action from. The possible values are: `urlbar`
, `handoff`, `urlbar_newtab` and `urlbar_addonpage`.
type: string
interaction:
description: >
How the user started the search action. The possible values are:
`typed`, `pasted`, `topsite_search` (clicked on a topsite search
shortcut), `topsites` (selected a topsite result with empty search
string), `returned` (The user abandoned a search, then returned to it)
, `restarted` (The user abandoned a search, then returned to it,
cleared it and typed a completely different string), `refined` (The
user abandoned a search, then returned to it, and partially modified
the string), `persisted_search_terms` (The user returned to a previous
successful search that persisted terms in the urlbar),
`persisted_search_terms_restarted` (The user returned to a previous
successful search that persisted terms in the urlbar, then cleared it
and typed a completely different string) and
`persisted_search_terms_refined` (The user returned to a previous
successful search that persisted terms in the urlbar, and partially
modified the string).
type: string
search_mode:
description: >
If the urlbar is in search mode, thus restricting results to a
specific search engine or local source, this is set to the search mode
source. The possible sources are: `actions`, `bookmarks`, `history`,
`search_engine`, and `tabs`. If search mode is active but the source
did not fall into any of these categories, this will be `unknown`. If
search mode is not active, this will be an empty string.
type: string
n_chars:
description: >
The length of string used for the search. It includes whitespaces.
type: quantity
n_words:
description: >
The length of words used for the search. The words are made by
splitting the search string by whitespaces, thus this doesn’t support
CJK languages. For performance reasons a maximum of 255 characters are
considered when splitting.
type: quantity
n_results:
description: >
The number of results shown to the user. If this is high the results
list below may be truncated due to technical limitations. Also note in
that case not all the results may be physically visible due to the
screen size limitation.
type: quantity
selected_result:
description: >
The type of the result the user selected. The possible result types
are: `autofill_about`, `autofill_adaptive`, `autofill_origin`,
`autofill_url`, `autofill_unknown`, `bookmark`, `history`, `keyword`,
`search_engine`, `search_suggest`, `search_history`, `url`, `action`,
`tab`, `remote_tab`, `addon`, `tip_onboard`, `tip_persist`,
`tip_redirect`, `tip_unknown`, `intervention_clear`,
`intervention_refresh`, `intervention_update`, `intervention_unknown`,
`tab_to_search`, `top_site`, `calc`, `unit`, `suggest_sponsor` and
`suggest_non_sponsor`. If the result type did not fall into any of
these, this will be `unknown`.
type: string
selected_result_subtype:
description: >
The subtype of the result the user selected. Currently, only the
action of the quick actions is the target to this. The possible values
are: `addon`, `bookmarks`, `clear`, `downloads`, `extensions`,
`inspect`, `logins`, `plugins`, `print`, `private`, `refresh`,
`restart`, `screenshot`, `settings`, `themes`, `update` and
`viewsource`. Otherwise, an empty string is returned.
type: string
provider:
description: >
The name of the `UrlbarProvider` that provided the selected result.
The possible values are: `AboutPages`, `AliasEngines`, `Autofill`,
`BookmarkKeywords`, `calculator`, `UrlbarProviderContextualSearch`,
`HeuristicFallback`, `InputHistory`, `UrlbarProviderInterventions`,
`Omnibox`, `OpenTabs`, `Places`, `PreloadedSites`, `PrivateSearch`,
`quickactions`, `UrlbarProviderQuickSuggest`, `RemoteTabs`,
`SearchSuggestions`, `UrlbarProviderSearchTips`, `TabToSearch`,
`TokenAliasEngines`, `UrlbarProviderTopSites`, `UnitConversion` and
`UnifiedComplete`.
type: string
engagement_type:
description: >
Records how the user selected the result. The possible values are:
`click`, `enter`, `drop_go`, `paste_go`, `dismiss`, `help`.
type: string
groups:
description: >
Comma separated list of result groups in the order they were shown to
the user. The groups may be repeated, since the list will match 1:1
the results list, so we can link each result to a group. The possible
group names are: `heuristic`, `adaptive_history`, `search_history`,
`search_suggest`, `top_pick`, `top_site`, `remote_tab`, `addon`,
`general`, `suggest`, `about_page` and `suggested_index`. If the group
did not fall into any of these, this will be `unknown` and a bug
should be filed to investigate it.
type: string
results:
description: >
Comma separated list of result types in the order they were shown to
the user. The possible result types are: `autofill_about`,
`autofill_adaptive`, `autofill_origin`, `autofill_url`,
`autofill_unknown`, `bookmark`, `history`, `keyword`, `search_engine`,
`search_suggest`, `search_history`, `url`, `action`, `tab`,
`remote_tab`, `addon`, `tip_onboard`, `tip_persist`, `tip_redirect`,
`tip_unknown`, `intervention_clear`, `intervention_refresh`,
`intervention_update`, `intervention_unknown`, `tab_to_search`,
`top_site`, `calc`, `unit`, `suggest_sponsor` and
`suggest_non_sponsor`. If the result type did not fall into any of
these, this will be `unknown` and a bug should be filed to investigate
it.
type: string
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1797265
- https://bugzilla.mozilla.org/show_bug.cgi?id=1805717
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1797265#c3
- https://bugzilla.mozilla.org/show_bug.cgi?id=1805717#c4
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
impression:
type: event
description: Recorded when urlbar results are shown to the user.
extra_keys:
reason:
description: Reason for the impression.
type: string
sap:
description: >
`sap` is the meaning of `search access point`. It records where the
user started the search action from. The possible values are: `urlbar`
, `handoff`, `urlbar_newtab` and `urlbar_addonpage`.
type: string
interaction:
description: >
How the user started the search action. The possible values are:
`typed`, `pasted`, `topsite_search` (clicked on a topsite search
shortcut), `topsites` (selected a topsite result with empty search
string), `returned` (The user abandoned a search, then returned to it)
, `restarted` (The user abandoned a search, then returned to it,
cleared it and typed a completely different string), `refined` (The
user abandoned a search, then returned to it, and partially modified
the string), `persisted_search_terms` (The user returned to a previous
successful search that persisted terms in the urlbar),
`persisted_search_terms_restarted` (The user returned to a previous
successful search that persisted terms in the urlbar, then cleared it
and typed a completely different string) and
`persisted_search_terms_refined` (The user returned to a previous
successful search that persisted terms in the urlbar, and partially
modified the string).
type: string
search_mode:
description: >
If the urlbar is in search mode, thus restricting results to a
specific search engine or local source, this is set to the search mode
source. The possible sources are: `actions`, `bookmarks`, `history`,
`search_engine`, and `tabs`. If search mode is active but the source
did not fall into any of these categories, this will be `unknown`. If
search mode is not active, this will be an empty string.
type: string
n_chars:
description: >
The length of string used for the search. It includes whitespaces.
type: quantity
n_words:
description: >
The length of words used for the search. The words are made by
splitting the search string by whitespaces, thus this doesn’t support
CJK languages. For performance reasons a maximum of 255 characters are
considered when splitting.
type: quantity
n_results:
description: >
The number of results shown to the user. If this is high the results
list below may be truncated due to technical limitations. Also note in
that case not all the results may be physically visible due to the
screen size limitation.
type: quantity
groups:
description: >
Comma separated list of result groups in the order they were shown to
the user. The groups may be repeated, since the list will match 1:1
the results list, so we can link each result to a group. The possible
group names are: `heuristic`, `adaptive_history`, `search_history`,
`search_suggest`, `top_pick`, `top_site`, `remote_tab`, `addon`,
`general`, `suggest`, `about_page` and `suggested_index`. If the group
did not fall into any of these, this will be `unknown` and a bug
should be filed to investigate it.
type: string
results:
description: >
Comma separated list of result types in the order they were shown to
the user. The possible result types are: `autofill_about`,
`autofill_adaptive`, `autofill_origin`, `autofill_url`,
`autofill_unknown`, `bookmark`, `history`, `keyword`, `search_engine`,
`search_suggest`, `search_history`, `url`, `action`, `tab`,
`remote_tab`, `addon`, `tip_onboard`, `tip_persist`, `tip_redirect`,
`tip_unknown`, `intervention_clear`, `intervention_refresh`,
`intervention_update`, `intervention_unknown`, `tab_to_search`,
`top_site`, `calc`, `unit`, `suggest_sponsor` and
`suggest_non_sponsor`. If the result type did not fall into any of
these, this will be `unknown` and a bug should be filed to investigate
it.
type: string
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1800579
- https://bugzilla.mozilla.org/show_bug.cgi?id=1805717
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1800579#c4
- https://bugzilla.mozilla.org/show_bug.cgi?id=1805717#c4
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
|
