metrics.yaml (55687B)
1 # This Source Code Form is subject to the terms of the Mozilla Public 2 # License, v. 2.0. If a copy of the MPL was not distributed with this 3 # file, You can obtain one at http://mozilla.org/MPL/2.0/. 4 5 # Adding a new metric? We have docs for that! 6 # https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html 7 8 --- 9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0 10 $tags: 11 - "Firefox :: Address Bar" 12 13 urlbar: 14 abandonment: 15 type: event 16 description: Recorded when the user abandons a search (blurring the urlbar). 17 extra_keys: 18 abandonment_type: 19 description: > 20 Records the reason that resulted in an abandonment. The possible 21 values are: `blur` and `tab_switch`. 22 type: string 23 sap: 24 description: > 25 `sap` is the meaning of `search access point`. It records where the 26 user started the search action from. The possible values are: `urlbar` 27 , `handoff`, `urlbar_newtab`, `urlbar_addonpage`, and `searchbar`. 28 type: string 29 interaction: 30 description: > 31 How the user started the search action. The possible values are: 32 `typed`, `pasted`, `topsite_search` (clicked on a topsite search 33 shortcut), `topsites` (selected a topsite result with empty search 34 string), `returned` (The user abandoned a search, then returned to it) 35 , `restarted` (The user abandoned a search, then returned to it, 36 cleared it and typed a completely different string), `refined` (The 37 user abandoned a search, then returned to it, and partially modified 38 the string), `persisted_search_terms` (The user returned to a previous 39 successful search that persisted terms in the urlbar), 40 `persisted_search_terms_restarted` (The user returned to a previous 41 successful search that persisted terms in the urlbar, then cleared it 42 and typed a completely different string) and 43 `persisted_search_terms_refined` (The user returned to a previous 44 successful search that persisted terms in the urlbar, and partially 45 modified the string). 46 type: string 47 search_mode: 48 description: > 49 If the urlbar is in search mode, thus restricting results to a 50 specific search engine or local source, this is set to the search mode 51 source. The possible sources are: `actions`, `bookmarks`, `history`, 52 `search_engine`, and `tabs`. If search mode is active but the source 53 did not fall into any of these categories, this will be `unknown`. If 54 search mode is not active, this will be an empty string. 55 type: string 56 search_engine_default_id: 57 description: > 58 The telemetry id of the search engine. 59 Reflects `search.engine.default.engine_id`. 60 type: string 61 n_chars: 62 description: > 63 The length of string used for the search. It includes whitespaces. 64 type: quantity 65 n_words: 66 description: > 67 The length of words used for the search. The words are made by 68 splitting the search string by whitespaces, thus this doesn’t support 69 CJK languages. For performance reasons a maximum of 255 characters are 70 considered when splitting. 71 type: quantity 72 n_results: 73 description: > 74 The number of results shown to the user. If this is high the results 75 list below may be truncated due to technical limitations. Also note in 76 that case not all the results may be physically visible due to the 77 screen size limitation. 78 type: quantity 79 groups: 80 description: > 81 Comma separated list of result groups in the order they were shown to 82 the user. The groups may be repeated, since the list will match 1:1 83 the results list, so we can link each result to a group. The possible 84 group names are: `heuristic`, `adaptive_history`, `search_history`, 85 `search_suggest`, `search_suggest_rich`, `trending_search`, 86 `trending_search_rich`, `top_pick`, `top_site`, `remote_tab`, 87 `addon`, `general`, `suggest`, `about_page`, `suggested_index`, and 88 `restrict_keyword`. 89 If the group did not fall into any of these, 90 this will be `unknown` and a bug should be filed to investigate it. 91 type: string 92 results: 93 description: > 94 Comma separated list of result types in the order they were shown to 95 the user. The `unknown` type should not occur and indicates a bug. The 96 possible types are: 97 `action`, 98 `addon`, 99 `autofill_about`, 100 `autofill_adaptive`, 101 `autofill_origin`, 102 `autofill_unknown`, 103 `autofill_url`, 104 `bookmark`, 105 `bookmark_adaptive`, 106 `bookmark_adaptive_serp`, 107 `bookmark_serp`, 108 `calc`, 109 `clipboard`, 110 `fxsuggest_data_sharing_opt_in`, 111 `history`, 112 `history_adaptive`, 113 `history_adaptive_serp`, 114 `history_semantic`, 115 `history_semantic_serp`, 116 `history_serp`, 117 `intervention_clear`, 118 `intervention_refresh`, 119 `intervention_unknown`, 120 `intervention_update`, 121 `keyword`, 122 `merino_adm_sponsored`, 123 `merino_amo`, 124 `merino_market`, 125 `merino_top_picks`, 126 `merino_wikipedia`, 127 `ml_yelp`, 128 `recent_search`, 129 `remote_tab`, 130 `restrict_keyword_actions`, 131 `restrict_keyword_bookmarks`, 132 `restrict_keyword_history`, 133 `restrict_keyword_tabs`, 134 `rust_adm_nonsponsored`, 135 `rust_adm_sponsored`, 136 `rust_amo`, 137 `rust_exposure`, 138 `rust_important_dates`, 139 `rust_market_opt_in`, 140 `rust_mdn`, 141 `rust_yelp`, 142 `search_engine`, 143 `search_history`, 144 `search_suggest`, 145 `search_suggest_rich`, 146 `tab`, 147 `tab_adaptive`, 148 `tab_adaptive_serp`, 149 `tab_semantic`, 150 `tab_semantic_serp`, 151 `tab_serp`, 152 `tab_to_search`, 153 `tip_dismissal_acknowledgment`, 154 `tip_onboard`, 155 `tip_redirect`, 156 `tip_unknown`, 157 `top_site`, 158 `trending_search`, 159 `trending_search_rich`, 160 `unit`, 161 `url`, 162 `weather` 163 type: string 164 actions: 165 description: > 166 Comma separated list of actions keys in the order they were shown to 167 the user. Possible keys are: `addons`, `bookmarks`, `clear`, `downloads`, 168 `extensions`, `inspect`, `logins`, `print`, `private`, 169 `refresh`, `restart`, `savepdf`, `screenshot`, `settings`, `tabswitch`, 170 `themes`, `update`, `viewsource`. 171 If there is no action shown in a position that is denoted with `none`. 172 type: string 173 available_semantic_sources: 174 description: > 175 Comma separated list of semantic sources that were available to search. 176 This indicates general availability of the source, not whether it was 177 queried. 178 The possible values are: `history`, `none`. 179 type: string 180 bugs: 181 - https://bugzilla.mozilla.org/show_bug.cgi?id=1800414 182 - https://bugzilla.mozilla.org/show_bug.cgi?id=1805717 183 - https://bugzilla.mozilla.org/show_bug.cgi?id=1842247 184 - https://bugzilla.mozilla.org/show_bug.cgi?id=1917992 185 data_reviews: 186 - https://bugzilla.mozilla.org/show_bug.cgi?id=1800414#c2 187 - https://bugzilla.mozilla.org/show_bug.cgi?id=1805717#c4 188 - https://bugzilla.mozilla.org/show_bug.cgi?id=1842247#c3 189 - https://bugzilla.mozilla.org/show_bug.cgi?id=1917992 190 data_sensitivity: 191 - interaction 192 notification_emails: 193 - fx-search-telemetry@mozilla.com 194 expires: never 195 196 bounce: 197 type: event 198 description: Recorded when the user leaves a page loaded by picking an address bar result and they spent less than 10s on it. 199 extra_keys: 200 sap: 201 description: > 202 `sap` is the meaning of `search access point`. It records where the 203 user started the search action from. The possible values are: `urlbar` 204 , `handoff`, `urlbar_newtab`, `urlbar_addonpage`, and `searchbar`. 205 type: string 206 interaction: 207 description: > 208 How the user started the search action. The possible values are: 209 `typed`, `pasted`, `topsite_search` (clicked on a topsite search 210 shortcut), `topsites` (selected a topsite result with empty search 211 string), `returned` (The user abandoned a search, then returned to it) 212 , `restarted` (The user abandoned a search, then returned to it, 213 cleared it and typed a completely different string), `refined` (The 214 user abandoned a search, then returned to it, and partially modified 215 the string), `persisted_search_terms` (The user returned to a previous 216 successful search that persisted terms in the urlbar), 217 `persisted_search_terms_restarted` (The user returned to a previous 218 successful search that persisted terms in the urlbar, then cleared it 219 and typed a completely different string) and 220 `persisted_search_terms_refined` (The user returned to a previous 221 successful search that persisted terms in the urlbar, and partially 222 modified the string). 223 type: string 224 search_mode: 225 description: > 226 If the urlbar is in search mode, thus restricting results to a 227 specific search engine or local source, this is set to the search mode 228 source. The possible sources are: `actions`, `bookmarks`, `history`, 229 `search_engine`, and `tabs`. If search mode is active but the source 230 did not fall into any of these categories, this will be `unknown`. If 231 search mode is not active, this will be an empty string. 232 type: string 233 search_engine_default_id: 234 description: > 235 The telemetry id of the search engine. 236 Reflects `search.engine.default.engine_id`. 237 type: string 238 n_chars: 239 description: > 240 The length of string used for the search. It includes whitespaces. 241 type: quantity 242 n_words: 243 description: > 244 The length of words used for the search. The words are made by 245 splitting the search string by whitespaces, thus this doesn’t support 246 CJK languages. For performance reasons a maximum of 255 characters are 247 considered when splitting. 248 type: quantity 249 n_results: 250 description: > 251 The number of results shown to the user. If this is high the results 252 list below may be truncated due to technical limitations. Also note in 253 that case not all the results may be physically visible due to the 254 screen size limitation. 255 type: quantity 256 selected_result: 257 description: > 258 The type of the result the user selected. This is to be set as the 259 selected_result value of the last engagement event. 260 type: string 261 selected_position: 262 description: > 263 The 1-based index of the result the user selected. If user searched 264 without selection, 0 will be recorded. 265 type: quantity 266 provider: 267 description: > 268 The name of the `UrlbarProvider` that provided the selected result. 269 The possible values are: `AboutPages`, `AliasEngines`, `Autofill`, 270 `BookmarkKeywords`, `calculator`, `UrlbarProviderContextualSearch`, 271 `HeuristicFallback`, `HistoryUrlHeuristic`, `InputHistory`, 272 `UrlbarProviderInterventions`, `Omnibox`, `OpenTabs`, `Places`, 273 `PrivateSearch`, `quickactions`, `UrlbarProviderQuickSuggest`, 274 `RemoteTabs`, `SearchSuggestions`, `UrlbarProviderSearchTips`, 275 `TabToSearch`, `TokenAliasEngines`, `UrlbarProviderTopSites`, 276 `UnitConversion` and `UnifiedComplete`. 277 If engagement_type is `drop_go` or `paste_go`, this will be null 278 because no results are shown. And also, if selected_result is 279 `experimental_addon`, it means that the user selected a result 280 from an add-on using the urlbar experimental API. In this case, 281 this will be the provider name specified by the add-on. 282 type: string 283 engagement_type: 284 description: > 285 Records how the user selected the result. The possible values are the same 286 as those defined for the engagement event engagement_type property. 287 type: string 288 results: 289 description: > 290 Comma separated list of result types in the order they were shown to 291 the user. The `unknown` type should not occur and indicates a bug. The 292 types are one of the values defined for the engagement event results property. 293 type: string 294 view_time: 295 description: > 296 The number of seconds the user spent on the page. 297 type: quantity 298 threshold: 299 description: > 300 The view time threshold for bounce detection, in seconds. 301 type: quantity 302 bugs: 303 - https://bugzilla.mozilla.org/show_bug.cgi?id=1959741 304 data_reviews: 305 - https://bugzilla.mozilla.org/show_bug.cgi?id=1959741 306 data_sensitivity: 307 - interaction 308 notification_emails: 309 - fx-search-telemetry@mozilla.com 310 expires: never 311 312 313 disable: 314 type: event 315 description: > 316 Recorded after a search containing a Suggest result is engaged 317 or abandoned. Number of seconds is controlled by hidden 318 browser.urlbar.disableSuggestEvent.maxSecondsFromLastSearch pref. 319 Reported values refer to the last search. 320 extra_keys: 321 sap: 322 description: > 323 `sap` is the meaning of `search access point`. It records where the 324 user started the search action from. The possible values are: `urlbar` 325 , `handoff`, `urlbar_newtab`, `urlbar_addonpage`, and `searchbar`. 326 type: string 327 interaction: 328 description: > 329 How the user started the search action. The possible values are: 330 `typed`, `pasted`, `topsite_search` (clicked on a topsite search 331 shortcut), `topsites` (selected a topsite result with empty search 332 string), `returned` (The user abandoned a search, then returned to it) 333 , `restarted` (The user abandoned a search, then returned to it, 334 cleared it and typed a completely different string), `refined` (The 335 user abandoned a search, then returned to it, and partially modified 336 the string), `persisted_search_terms` (The user returned to a previous 337 successful search that persisted terms in the urlbar), 338 `persisted_search_terms_restarted` (The user returned to a previous 339 successful search that persisted terms in the urlbar, then cleared it 340 and typed a completely different string) and 341 `persisted_search_terms_refined` (The user returned to a previous 342 successful search that persisted terms in the urlbar, and partially 343 modified the string). 344 type: string 345 search_mode: 346 description: > 347 If the urlbar is in search mode, thus restricting results to a 348 specific search engine or local source, this is set to the search mode 349 source. The possible sources are: `actions`, `bookmarks`, `history`, 350 `search_engine`, and `tabs`. If search mode is active but the source 351 did not fall into any of these categories, this will be `unknown`. If 352 search mode is not active, this will be an empty string. 353 type: string 354 search_engine_default_id: 355 description: > 356 The telemetry id of the search engine. 357 Reflects `search.engine.default.engine_id`. 358 type: string 359 n_chars: 360 description: > 361 The length of string used for the search. It includes whitespaces. 362 type: quantity 363 n_words: 364 description: > 365 The length of words used for the search. The words are made by 366 splitting the search string by whitespaces, thus this doesn’t support 367 CJK languages. For performance reasons a maximum of 255 characters are 368 considered when splitting. 369 type: quantity 370 n_results: 371 description: > 372 The number of results shown to the user. If this is high the results 373 list below may be truncated due to technical limitations. Also note in 374 that case not all the results may be physically visible due to the 375 screen size limitation. 376 type: quantity 377 selected_result: 378 description: > 379 The type of the result the user selected. If the last search was an engagement, 380 it will be set to the selected_result value of the engagement event, otherwise in 381 the case of the abandonment event, it will be set to `none`. 382 type: string 383 results: 384 description: > 385 Comma separated list of result types in the order they were shown to 386 the user. The `unknown` type should not occur and indicates a bug. The 387 types are one of the values defined for the engagement event results property. 388 type: string 389 feature: 390 description: > 391 The specific feature that is being disabled. The possible types are: 392 `suggest` 393 More values may be added in the future. 394 type: string 395 bugs: 396 - https://bugzilla.mozilla.org/show_bug.cgi?id=1960836 397 data_reviews: 398 - https://bugzilla.mozilla.org/show_bug.cgi?id=1960836 399 data_sensitivity: 400 - interaction 401 notification_emails: 402 - fx-search-telemetry@mozilla.com 403 expires: never 404 405 engagement: 406 type: event 407 description: Recorded when the user executes an action on a result. 408 extra_keys: 409 sap: 410 description: > 411 `sap` is the meaning of `search access point`. It records where the 412 user started the search action from. The possible values are: `urlbar` 413 , `handoff`, `urlbar_newtab`, `urlbar_addonpage`, and `searchbar`. 414 type: string 415 interaction: 416 description: > 417 How the user started the search action. The possible values are: 418 `typed`, `pasted`, `topsite_search` (clicked on a topsite search 419 shortcut), `topsites` (selected a topsite result with empty search 420 string), `returned` (The user abandoned a search, then returned to it) 421 , `restarted` (The user abandoned a search, then returned to it, 422 cleared it and typed a completely different string), `refined` (The 423 user abandoned a search, then returned to it, and partially modified 424 the string), `persisted_search_terms` (The user returned to a previous 425 successful search that persisted terms in the urlbar), 426 `persisted_search_terms_restarted` (The user returned to a previous 427 successful search that persisted terms in the urlbar, then cleared it 428 and typed a completely different string) and 429 `persisted_search_terms_refined` (The user returned to a previous 430 successful search that persisted terms in the urlbar, and partially 431 modified the string). 432 type: string 433 search_mode: 434 description: > 435 If the urlbar is in search mode, thus restricting results to a 436 specific search engine or local source, this is set to the search mode 437 source. The possible sources are: `actions`, `bookmarks`, `history`, 438 `search_engine`, and `tabs`. If search mode is active but the source 439 did not fall into any of these categories, this will be `unknown`. If 440 search mode is not active, this will be an empty string. 441 type: string 442 search_engine_default_id: 443 description: > 444 The telemetry id of the search engine. 445 Reflects `search.engine.default.engine_id`. 446 type: string 447 n_chars: 448 description: > 449 The length of string used for the search. It includes whitespaces. 450 type: quantity 451 n_words: 452 description: > 453 The length of words used for the search. The words are made by 454 splitting the search string by whitespaces, thus this doesn’t support 455 CJK languages. For performance reasons a maximum of 255 characters are 456 considered when splitting. 457 type: quantity 458 n_results: 459 description: > 460 The number of results shown to the user. If this is high the results 461 list below may be truncated due to technical limitations. Also note in 462 that case not all the results may be physically visible due to the 463 screen size limitation. 464 type: quantity 465 selected_result: 466 description: > 467 The type of the result the user selected. The `unknown` type should 468 not occur and indicates a bug. The possible types are: 469 `action`, 470 `addon`, 471 `autofill_about`, 472 `autofill_adaptive`, 473 `autofill_origin`, 474 `autofill_unknown`, 475 `autofill_url`, 476 `bookmark`, 477 `bookmark_adaptive`, 478 `bookmark_adaptive_serp`, 479 `bookmark_serp`, 480 `calc`, 481 `clipboard`, 482 `experimental_addon`, 483 `fxsuggest_data_sharing_opt_in`, 484 `history`, 485 `history_adaptive`, 486 `history_adaptive_serp`, 487 `history_semantic`, 488 `history_semantic_serp`, 489 `history_serp`, 490 `input_field`, 491 `intervention_clear`, 492 `intervention_refresh`, 493 `intervention_unknown`, 494 `intervention_update`, 495 `keyword`, 496 `merino_adm_sponsored`, 497 `merino_amo`, 498 `merino_market`, 499 `merino_top_picks`, 500 `merino_wikipedia`, 501 `ml_yelp`, 502 `recent_search`, 503 `remote_tab`, 504 `restrict_keyword_actions`, 505 `restrict_keyword_bookmarks`, 506 `restrict_keyword_history`, 507 `restrict_keyword_tabs`, 508 `rust_adm_nonsponsored`, 509 `rust_adm_sponsored`, 510 `rust_amo`, 511 `rust_exposure`, 512 `rust_important_dates`, 513 `rust_market_opt_in`, 514 `rust_mdn`, 515 `rust_yelp`, 516 `search_engine`, 517 `search_history`, 518 `search_shortcut_button`, 519 `search_suggest`, 520 `search_suggest_rich`, 521 `site_specific_contextual_search`, 522 `tab`, 523 `tab_adaptive`, 524 `tab_adaptive_serp`, 525 `tab_semantic`, 526 `tab_semantic_serp`, 527 `tab_serp`, 528 `tab_to_search`, 529 `tip_dismissal_acknowledgment`, 530 `tip_onboard`, 531 `tip_redirect`, 532 `tip_unknown`, 533 `top_site`, 534 `trending_search`, 535 `trending_search_rich`, 536 `unit`, 537 `url`, 538 `weather` 539 If the user has selected an action this will be set with an action 540 prefix as followed 541 `action_*` 542 Where the wildcard(*) will be replaced by one of the values 543 documented in the actions field. 544 type: string 545 selected_position: 546 description: > 547 The 1-based index of the result the user selected. If user searched 548 without selection, 0 will be recorded. 549 type: quantity 550 provider: 551 description: > 552 The name of the `UrlbarProvider` that provided the selected result. 553 The possible values are: `AboutPages`, `AliasEngines`, `Autofill`, 554 `BookmarkKeywords`, `calculator`, `UrlbarProviderContextualSearch`, 555 `HeuristicFallback`, `HistoryUrlHeuristic`, `InputHistory`, 556 `UrlbarProviderInterventions`, `Omnibox`, `OpenTabs`, `Places`, 557 `PrivateSearch`, `quickactions`, `UrlbarProviderQuickSuggest`, 558 `RemoteTabs`, `SearchSuggestions`, `UrlbarProviderSearchTips`, 559 `TabToSearch`, `TokenAliasEngines`, `UrlbarProviderTopSites`, 560 `UnitConversion` and `UnifiedComplete`. 561 If engagement_type is `drop_go` or `paste_go`, this will be null 562 because no results are shown. And also, if selected_result is 563 `experimental_addon`, it means that the user selected a result 564 from an add-on using the urlbar experimental API. In this case, 565 this will be the provider name specified by the add-on. 566 type: string 567 engagement_type: 568 description: > 569 Records how the user selected the result. The possible values are: 570 `click`, 571 `dismiss`, 572 `drop_go`, 573 `enter`, 574 `go_button`, 575 `help`, 576 `inaccurate_location`, 577 `manage`, 578 `not_interested`, 579 `not_now`, 580 `not_relevant`, 581 `opt_in`, 582 `paste_go`, 583 `show_less_frequently` 584 type: string 585 groups: 586 description: > 587 Comma separated list of result groups in the order they were shown to 588 the user. The groups may be repeated, since the list will match 1:1 589 the results list, so we can link each result to a group. The possible 590 group names are: `heuristic`, `adaptive_history`, `search_history`, 591 `search_suggest`, `search_suggest_rich`, `trending_search`, 592 `trending_search_rich`, `top_pick`, `top_site`, `recent_search`, 593 `remote_tab`, `addon`, `general`, `suggest`, `about_page`, 594 `suggested_index`, and `restrict_keyword`. 595 If the group did not fall into any of these, this will be `unknown` 596 and a bug should be filed to investigate it. If engagement_type is 597 `drop_go` or `paste_go`, this will be empty string because no results 598 are shown. 599 type: string 600 results: 601 description: > 602 Comma separated list of result types in the order they were shown to 603 the user. The `unknown` type should not occur and indicates a bug. The 604 possible types are: 605 `action`, 606 `addon`, 607 `autofill_about`, 608 `autofill_adaptive`, 609 `autofill_origin`, 610 `autofill_unknown`, 611 `autofill_url`, 612 `bookmark`, 613 `bookmark_adaptive`, 614 `bookmark_adaptive_serp`, 615 `bookmark_serp`, 616 `calc`, 617 `clipboard`, 618 `fxsuggest_data_sharing_opt_in`, 619 `history`, 620 `history_adaptive`, 621 `history_adaptive_serp`, 622 `history_semantic`, 623 `history_semantic_serp`, 624 `history_serp`, 625 `intervention_clear`, 626 `intervention_refresh`, 627 `intervention_unknown`, 628 `intervention_update`, 629 `keyword`, 630 `merino_adm_sponsored`, 631 `merino_amo`, 632 `merino_market`, 633 `merino_top_picks`, 634 `merino_wikipedia`, 635 `ml_yelp`, 636 `recent_search`, 637 `remote_tab`, 638 `restrict_keyword_actions`, 639 `restrict_keyword_bookmarks`, 640 `restrict_keyword_history`, 641 `restrict_keyword_tabs`, 642 `rust_adm_nonsponsored`, 643 `rust_adm_sponsored`, 644 `rust_amo`, 645 `rust_exposure`, 646 `rust_important_dates`, 647 `rust_market_opt_in`, 648 `rust_mdn`, 649 `rust_yelp`, 650 `search_engine`, 651 `search_history`, 652 `search_suggest`, 653 `search_suggest_rich`, 654 `tab`, 655 `tab_adaptive`, 656 `tab_adaptive_serp`, 657 `tab_semantic`, 658 `tab_semantic_serp`, 659 `tab_serp`, 660 `tab_to_search`, 661 `tip_dismissal_acknowledgment`, 662 `tip_onboard`, 663 `tip_redirect`, 664 `tip_unknown`, 665 `top_site`, 666 `trending_search`, 667 `trending_search_rich`, 668 `unit`, 669 `url`, 670 `weather` 671 type: string 672 actions: 673 description: > 674 Comma separated list of actions keys in the order they were shown to 675 the user. Possible keys are: `addons`, `bookmarks`, `clear`, `downloads`, 676 `extensions`, `inspect`, `logins`, `print`, `private`, 677 `refresh`, `restart`, `savepdf`, `screenshot`, `settings`, `tabswitch`, 678 `themes`, `update`, `viewsource`. 679 If there is no action shown in a position that is denoted with `none`. 680 type: string 681 available_semantic_sources: 682 description: > 683 Comma separated list of semantic sources that were available to search. 684 This indicates general availability of the source, not whether it was 685 queried. 686 The possible values are: `history`, `none`. 687 type: string 688 bugs: 689 - https://bugzilla.mozilla.org/show_bug.cgi?id=1797265 690 - https://bugzilla.mozilla.org/show_bug.cgi?id=1805717 691 - https://bugzilla.mozilla.org/show_bug.cgi?id=1842247 692 data_reviews: 693 - https://bugzilla.mozilla.org/show_bug.cgi?id=1797265#c3 694 - https://bugzilla.mozilla.org/show_bug.cgi?id=1805717#c4 695 - https://bugzilla.mozilla.org/show_bug.cgi?id=1842247#c3 696 data_sensitivity: 697 - interaction 698 notification_emails: 699 - fx-search-telemetry@mozilla.com 700 expires: never 701 702 heuristic_result_missing: 703 type: rate 704 description: > 705 A uint recording the number of times the address bar handleCommand fallback 706 path is hit. 707 bugs: 708 - https://bugzilla.mozilla.org/show_bug.cgi?id=1650819 709 data_reviews: 710 - https://bugzilla.mozilla.org/show_bug.cgi?id=1650819 711 notification_emails: 712 - fx-search-telemetry@mozilla.com 713 data_sensitivity: 714 - technical 715 expires: never 716 717 exposure: 718 type: event 719 description: > 720 Recorded when client is exposed to urlbar experiment results. 721 extra_keys: 722 results: 723 description: > 724 Comma separated list of results that were exposed to the user. 725 type: string 726 terminal: 727 description: > 728 Comma separated list of booleans that indicates whether the results 729 were present at the end of the urlbar session. This list is parallel 730 to the `results` list. i.e., the boolean at index i is true if the 731 result at index i was present at the end of the session. For example, 732 if `results` is "bookmark,history,search_suggest" and the bookmark was 733 not present at the end of the session, the history result was present, 734 and the search suggestion was not present, then `terminal` will be 735 "false,true,false". 736 type: string 737 bugs: 738 - https://bugzilla.mozilla.org/show_bug.cgi?id=1819766 739 - https://bugzilla.mozilla.org/show_bug.cgi?id=1918299 740 data_reviews: 741 - https://bugzilla.mozilla.org/show_bug.cgi?id=1819766#c9 742 data_sensitivity: 743 - interaction 744 notification_emails: 745 - fx-search-telemetry@mozilla.com 746 expires: never 747 748 keyword_exposure: 749 type: event 750 description: > 751 When keyword exposures are enabled, this event is recorded in the 752 `urlbar-keyword-exposure` ping, which is submitted at the end of urlbar 753 sessions during which one or more exposure results are matched. The ping 754 will contain one `keyword_exposure` event for each instance where a result 755 is matched during the session. See the `urlbar-keyword-exposure` ping for 756 details. 757 extra_keys: 758 result: 759 type: string 760 description: > 761 The type of result that was matched. 762 keyword: 763 type: string 764 description: > 765 The keyword that matched the result. 766 terminal: 767 type: boolean 768 description: > 769 Whether the matched result and keyword were present at the end of the 770 urlbar session. If true, the session ended with them. If false, the 771 result and keyword were matched at some point during the session but 772 the session did not end with them. 773 bugs: 774 - https://bugzilla.mozilla.org/show_bug.cgi?id=1881875 775 - https://bugzilla.mozilla.org/show_bug.cgi?id=1915507 776 data_reviews: 777 - https://bugzilla.mozilla.org/show_bug.cgi?id=1881875 778 - https://bugzilla.mozilla.org/show_bug.cgi?id=1915507 779 data_sensitivity: 780 - stored_content 781 notification_emails: 782 - fx-search-telemetry@mozilla.com 783 expires: never 784 send_in_pings: 785 - urlbar-keyword-exposure 786 787 pref_max_results: 788 lifetime: application 789 type: quantity 790 unit: integer 791 description: > 792 Maximum results to show in the Address Bar. 793 Corresponds to the value of the `browser.urlbar.maxRichResults` pref. 794 bugs: 795 - https://bugzilla.mozilla.org/show_bug.cgi?id=1817196 796 data_reviews: 797 - https://bugzilla.mozilla.org/show_bug.cgi?id=1817196 798 data_sensitivity: 799 - interaction 800 notification_emails: 801 - fx-search-telemetry@mozilla.com 802 expires: never 803 send_in_pings: 804 - events 805 806 pref_suggest_all: 807 lifetime: application 808 type: boolean 809 description: > 810 Whether Suggest results are shown in the urlbar. 811 Corresponds to the value of the 812 `browser.urlbar.suggest.quicksuggest.all` pref. 813 bugs: 814 - https://bugzilla.mozilla.org/show_bug.cgi?id=1995574 815 data_reviews: 816 - https://bugzilla.mozilla.org/show_bug.cgi?id=1995574 817 data_sensitivity: 818 - interaction 819 notification_emails: 820 - fx-search-telemetry@mozilla.com 821 expires: never 822 send_in_pings: 823 - events 824 825 pref_suggest_online_available: 826 lifetime: application 827 type: boolean 828 description: > 829 Whether online Suggest is available to the user. 830 Corresponds to the Nimbus variable `quickSuggestOnlineAvailable` and its 831 fallback pref `browser.urlbar.quicksuggest.online.available`. 832 NOTE: "Online Suggest" in this context means the new version of online 833 Suggest introduced in 146 with Terms of Use and OHTTP. 834 bugs: 835 - https://bugzilla.mozilla.org/show_bug.cgi?id=1995362 836 data_reviews: 837 - https://bugzilla.mozilla.org/show_bug.cgi?id=1995362 838 data_sensitivity: 839 - interaction 840 notification_emails: 841 - fx-search-telemetry@mozilla.com 842 expires: never 843 send_in_pings: 844 - events 845 846 pref_suggest_online_enabled: 847 lifetime: application 848 type: boolean 849 description: > 850 This pref is true for all users by default! You probably want to use this 851 in conjunction with pref_suggest_online_available and/or restrict your 852 analysis to user populations where you know online Suggest is available. 853 Corresponds to `browser.urlbar.quicksuggest.online.enabled`. 854 NOTE: "Online Suggest" in this context means the new version of online 855 Suggest introduced in 146 with Terms of Use and OHTTP. 856 bugs: 857 - https://bugzilla.mozilla.org/show_bug.cgi?id=1995362 858 data_reviews: 859 - https://bugzilla.mozilla.org/show_bug.cgi?id=1995362 860 data_sensitivity: 861 - interaction 862 notification_emails: 863 - fx-search-telemetry@mozilla.com 864 expires: never 865 send_in_pings: 866 - events 867 868 pref_suggest_sponsored: 869 lifetime: application 870 type: boolean 871 description: > 872 Whether sponsored quick suggest results are shown in the urlbar. 873 Corresponds to the value of the 874 `browser.urlbar.suggest.quicksuggest.sponsored` pref. 875 bugs: 876 - https://bugzilla.mozilla.org/show_bug.cgi?id=1847855 877 - https://bugzilla.mozilla.org/show_bug.cgi?id=1849726 878 data_reviews: 879 - https://bugzilla.mozilla.org/show_bug.cgi?id=1847855 880 data_sensitivity: 881 - interaction 882 notification_emails: 883 - fx-search-telemetry@mozilla.com 884 expires: never 885 send_in_pings: 886 - events 887 888 pref_suggest_topsites: 889 lifetime: application 890 type: boolean 891 description: > 892 Whether topsite results are enabled in the urlbar. 893 Corresponds to the value of the `browser.urlbar.suggest.topsites` pref. 894 bugs: 895 - https://bugzilla.mozilla.org/show_bug.cgi?id=1817196 896 data_reviews: 897 - https://bugzilla.mozilla.org/show_bug.cgi?id=1817196 898 data_sensitivity: 899 - interaction 900 notification_emails: 901 - fx-search-telemetry@mozilla.com 902 expires: never 903 send_in_pings: 904 - events 905 906 autofill_deletion: 907 type: counter 908 description: > 909 A uint recording the deletion count for autofilled string in the 910 urlbar. This occurs when the user deletes whole autofilled string by 911 BACKSPACE or DELETE key while the autofilled string is selected. 912 This metric was generated to correspond to the Legacy Telemetry 913 scalar urlbar.autofill_deletion. 914 bugs: 915 - https://bugzil.la/1815342 916 data_reviews: 917 - https://bugzil.la/1815342 918 notification_emails: 919 - fx-search-telemetry@mozilla.com 920 expires: never 921 telemetry_mirror: URLBAR_AUTOFILL_DELETION 922 923 autocomplete_first_result_time: 924 type: timing_distribution 925 description: > 926 PLACES: Time for first autocomplete result if > 50ms (ms) 927 928 This metric was generated to correspond to the Legacy Telemetry 929 exponential histogram PLACES_AUTOCOMPLETE_1ST_RESULT_TIME_MS. 930 time_unit: millisecond 931 bugs: 932 - https://bugzilla.mozilla.org/show_bug.cgi?id=1950710 933 data_reviews: 934 - https://bugzilla.mozilla.org/show_bug.cgi?id=1950710 935 notification_emails: 936 - fx-search-telemetry@mozilla.com 937 - adw@mozilla.com 938 expires: never 939 telemetry_mirror: PLACES_AUTOCOMPLETE_1ST_RESULT_TIME_MS 940 941 autocomplete_sixth_result_time: 942 type: timing_distribution 943 description: > 944 PLACES: Time for the 6 first autocomplete results (ms) 945 946 This metric was generated to correspond to the Legacy Telemetry 947 exponential histogram PLACES_AUTOCOMPLETE_6_FIRST_RESULTS_TIME_MS. 948 time_unit: millisecond 949 bugs: 950 - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524 951 data_reviews: 952 - https://bugzilla.mozilla.org/show_bug.cgi?id=1489524 953 notification_emails: 954 - fx-search-telemetry@mozilla.com 955 - adw@mozilla.com 956 expires: never 957 telemetry_mirror: PLACES_AUTOCOMPLETE_6_FIRST_RESULTS_TIME_MS 958 959 # Replacement for PingCentre "quicksuggest-block|impression|click" pings. 960 quick_suggest: 961 ping_type: 962 type: string 963 description: > 964 The ping's type. In other situations might be designated by an event's 965 name or an interaction field. E.g. "quicksuggest-impression", 966 "quicksuggest-block", "quicksuggest-click". 967 bugs: 968 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 969 data_reviews: 970 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 971 data_sensitivity: 972 - interaction 973 notification_emails: 974 - najiang@mozilla.com 975 expires: never 976 send_in_pings: 977 - quick-suggest 978 979 country: 980 type: string 981 description: > 982 Records the home region of the user as determined by `Region.sys.mjs` and 983 the `browser.search.region` pref. 984 bugs: 985 - https://bugzilla.mozilla.org/show_bug.cgi?id=1968154 986 data_reviews: 987 - https://bugzilla.mozilla.org/show_bug.cgi?id=1968154 988 data_sensitivity: 989 - technical 990 notification_emails: 991 - fx-search-telemetry@mozilla.com 992 - disco-team@mozilla.com 993 - ads-eng@mozilla.com 994 expires: never 995 send_in_pings: 996 - quick-suggest 997 998 position: 999 type: quantity 1000 unit: QuickSuggest position 1001 description: > 1002 The position (1-based) of the QuickSuggest item being interatcted with. 1003 bugs: 1004 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1005 data_reviews: 1006 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1007 data_sensitivity: 1008 - interaction 1009 notification_emails: 1010 - najiang@mozilla.com 1011 expires: never 1012 send_in_pings: 1013 - quick-suggest 1014 1015 suggested_index: 1016 type: string 1017 description: > 1018 A stringified integer value that is the intended index of the suggestion 1019 being interacted with. If `suggested_index_relative_to_group` is true, the 1020 index is relative to the "Firefox Suggest" group; otherwise the index is 1021 relative to the entire list of suggestions. Non-negative values (starting 1022 at 0) are relative to the start/top of the group/list; negative values are 1023 relative to the end/bottom of the group/list. 1024 bugs: 1025 - https://bugzilla.mozilla.org/show_bug.cgi?id=1854755 1026 data_reviews: 1027 - https://bugzilla.mozilla.org/show_bug.cgi?id=1854755 1028 data_sensitivity: 1029 - interaction 1030 notification_emails: 1031 - najiang@mozilla.com 1032 expires: never 1033 send_in_pings: 1034 - quick-suggest 1035 1036 suggested_index_relative_to_group: 1037 type: boolean 1038 description: > 1039 Whether `suggested_index` is relative to the "Firefox Suggest" group. If 1040 false, it is relative to the entire list of suggestions. 1041 bugs: 1042 - https://bugzilla.mozilla.org/show_bug.cgi?id=1854755 1043 data_reviews: 1044 - https://bugzilla.mozilla.org/show_bug.cgi?id=1854755 1045 data_sensitivity: 1046 - interaction 1047 notification_emails: 1048 - najiang@mozilla.com 1049 expires: never 1050 send_in_pings: 1051 - quick-suggest 1052 1053 source: 1054 type: string 1055 description: > 1056 The source of the interaction. E.g. "urlbar". 1057 bugs: 1058 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1059 data_reviews: 1060 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1061 data_sensitivity: 1062 - interaction 1063 notification_emails: 1064 - najiang@mozilla.com 1065 expires: never 1066 send_in_pings: 1067 - quick-suggest 1068 1069 match_type: 1070 type: string 1071 description: > 1072 Whether this was a best/top match or not. Either "best-match" or 1073 "firefox-suggest". 1074 bugs: 1075 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1076 data_reviews: 1077 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1078 data_sensitivity: 1079 - interaction 1080 notification_emails: 1081 - najiang@mozilla.com 1082 expires: never 1083 send_in_pings: 1084 - quick-suggest 1085 1086 block_id: 1087 type: string 1088 description: > 1089 A unique identifier for the suggestion (a.k.a. a keywords block). 1090 bugs: 1091 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1092 data_reviews: 1093 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1094 data_sensitivity: 1095 - interaction 1096 notification_emails: 1097 - najiang@mozilla.com 1098 expires: never 1099 send_in_pings: 1100 - quick-suggest 1101 1102 improve_suggest_experience: 1103 type: boolean 1104 description: > 1105 Whether online Suggest is available to the user and enabled. 1106 bugs: 1107 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1108 - https://bugzilla.mozilla.org/show_bug.cgi?id=1995362 1109 data_reviews: 1110 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1111 - https://bugzilla.mozilla.org/show_bug.cgi?id=1995362 1112 data_sensitivity: 1113 - interaction 1114 notification_emails: 1115 - najiang@mozilla.com 1116 expires: never 1117 send_in_pings: 1118 - quick-suggest 1119 1120 advertiser: 1121 type: string 1122 description: > 1123 The name of the advertiser providing the sponsored TopSite. 1124 bugs: 1125 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1126 data_reviews: 1127 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1128 data_sensitivity: 1129 - interaction 1130 - web_activity 1131 notification_emails: 1132 - najiang@mozilla.com 1133 expires: never 1134 send_in_pings: 1135 - quick-suggest 1136 1137 request_id: 1138 type: string 1139 description: > 1140 A request identifier for each API request to 1141 [Merino](https://mozilla-services.github.io/merino/). 1142 Only present for suggestions provided by Merino. 1143 bugs: 1144 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1145 data_reviews: 1146 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1147 data_sensitivity: 1148 - interaction 1149 - web_activity 1150 notification_emails: 1151 - najiang@mozilla.com 1152 expires: never 1153 send_in_pings: 1154 - quick-suggest 1155 1156 is_clicked: 1157 type: boolean 1158 description: > 1159 Whether this quicksuggest-impression ping was for an item that was 1160 clicked. 1161 bugs: 1162 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1163 data_reviews: 1164 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1165 data_sensitivity: 1166 - interaction 1167 notification_emails: 1168 - najiang@mozilla.com 1169 expires: never 1170 send_in_pings: 1171 - quick-suggest 1172 1173 reporting_url: 1174 type: url 1175 description: > 1176 The url to report this interaction to. 1177 bugs: 1178 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1179 data_reviews: 1180 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1181 data_sensitivity: 1182 - web_activity 1183 notification_emails: 1184 - najiang@mozilla.com 1185 expires: never 1186 send_in_pings: 1187 - quick-suggest 1188 1189 context_id: 1190 type: uuid 1191 description: > 1192 An identifier to identify users for Contextual Services user interaction pings. 1193 bugs: 1194 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1195 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941161 1196 data_reviews: 1197 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1198 - https://bugzilla.mozilla.org/show_bug.cgi?id=1941161 1199 data_sensitivity: 1200 - technical 1201 notification_emails: 1202 - najiang@mozilla.com 1203 expires: never 1204 send_in_pings: 1205 - quick-suggest 1206 - quick-suggest-deletion-request 1207 1208 iab_category: 1209 type: string 1210 description: > 1211 The suggestion's category. Either "22 - Shopping" or "5 - Educational". 1212 bugs: 1213 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1214 data_reviews: 1215 - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283 1216 data_sensitivity: 1217 - interaction 1218 - web_activity 1219 notification_emails: 1220 - najiang@mozilla.com 1221 expires: never 1222 send_in_pings: 1223 - quick-suggest 1224 1225 # Metrics from the Rust suggest component. 1226 # 1227 # We can't record metrics from Rust directly. To work around that we: 1228 # - Define the metrics here. 1229 # - Define API calls in Rust suggest component that return the metrics 1230 # alongside the normal results. 1231 # - Record the metrics in the JS code in this component 1232 1233 suggest: 1234 ingest_time: 1235 type: labeled_timing_distribution 1236 description: Time for ingestion (excluding download time), labelled by record type 1237 time_unit: microsecond 1238 labels: 1239 - icon 1240 - amp 1241 - wikipedia 1242 - amo-suggestions 1243 - yelp-suggestions 1244 - mdn-suggestions 1245 - weather 1246 - configuration 1247 bugs: 1248 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908397 1249 data_reviews: 1250 - https://bugzilla.mozilla.org/show_bug.cgi?id=1911664 1251 notification_emails: 1252 - disco-team@mozilla.com 1253 - bdk@mozilla.com 1254 expires: "never" 1255 data_sensitivity: 1256 - technical 1257 1258 ingest_download_time: 1259 type: labeled_timing_distribution 1260 description: Download time for ingestion, labelled by record type 1261 time_unit: microsecond 1262 labels: 1263 - icon 1264 - amp 1265 - wikipedia 1266 - amo-suggestions 1267 - yelp-suggestions 1268 - mdn-suggestions 1269 - weather 1270 - configuration 1271 bugs: 1272 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908397 1273 data_reviews: 1274 - https://bugzilla.mozilla.org/show_bug.cgi?id=1911664 1275 notification_emails: 1276 - disco-team@mozilla.com 1277 - bdk@mozilla.com 1278 expires: "never" 1279 data_sensitivity: 1280 - technical 1281 1282 query_time: 1283 type: labeled_timing_distribution 1284 description: Time executing queries, labelled by provider type 1285 time_unit: microsecond 1286 labels: 1287 - amp 1288 - wikipedia 1289 - amo 1290 - yelp 1291 - mdn 1292 - weather 1293 bugs: 1294 - https://bugzilla.mozilla.org/show_bug.cgi?id=1908397 1295 data_reviews: 1296 - https://bugzilla.mozilla.org/show_bug.cgi?id=1911664 1297 notification_emails: 1298 - disco-team@mozilla.com 1299 - bdk@mozilla.com 1300 expires: "never" 1301 data_sensitivity: 1302 - technical 1303 1304 # Relevance scoring & ranking metrics for Firefox Suggest. 1305 # This feature is still in the experimentation phase and all the metrics are 1306 # set to expire by 136 for now. 1307 suggest_relevance: 1308 status: 1309 type: labeled_counter 1310 description: > 1311 Count the successful / failed attempts of relevance scoring in 1312 Firefox Suggest. 1313 labels: 1314 - success 1315 - failure 1316 bugs: 1317 - https://bugzilla.mozilla.org/show_bug.cgi?id=1926315 1318 data_reviews: 1319 - https://bugzilla.mozilla.org/show_bug.cgi?id=1926315 1320 notification_emails: 1321 - disco-team@mozilla.com 1322 - najiang@mozilla.com 1323 expires: 153 1324 data_sensitivity: 1325 - technical 1326 outcome: 1327 type: labeled_counter 1328 description: > 1329 For each successful scoring, count whether the relevance score gets 1330 boosted or decreased over the original score. Note that given how the 1331 score is calculated, it's practically impossible to have the two scores 1332 tied. If that's the case anyhow, it will increment the "boosted" counter. 1333 labels: 1334 - boosted 1335 - decreased 1336 bugs: 1337 - https://bugzilla.mozilla.org/show_bug.cgi?id=1926315 1338 data_reviews: 1339 - https://bugzilla.mozilla.org/show_bug.cgi?id=1926315 1340 notification_emails: 1341 - disco-team@mozilla.com 1342 - najiang@mozilla.com 1343 expires: 153 1344 data_sensitivity: 1345 - technical 1346 1347 urlbar.trending: 1348 block: 1349 type: counter 1350 description: > 1351 User has blocked seeing trending results. 1352 This metric was generated to correspond to the Legacy Telemetry 1353 scalar urlbar.trending.block. 1354 bugs: 1355 - https://bugzil.la/1848048 1356 data_reviews: 1357 - https://bugzil.la/1848048 1358 notification_emails: 1359 - fx-search-telemetry@mozilla.com 1360 expires: never 1361 telemetry_mirror: URLBAR_TRENDING_BLOCK 1362 1363 urlbar.persistedsearchterms: 1364 revert_by_popup_count: 1365 type: counter 1366 description: > 1367 The count of the number of times search terms were removed from the 1368 urlbar due to a shown PopupNotification. This event can happen when 1369 a user loads a SERP and a PopupNotification is shown, as well as 1370 when a user switches away from a tab on a SERP showing a 1371 PopupNotification and switches back to it. 1372 This metric was generated to correspond to the Legacy Telemetry 1373 scalar urlbar.persistedsearchterms.revert_by_popup_count. 1374 bugs: 1375 - https://bugzil.la/1815971 1376 data_reviews: 1377 - https://bugzil.la/1815971 1378 notification_emails: 1379 - fx-search-telemetry@mozilla.com 1380 expires: never 1381 telemetry_mirror: URLBAR_PERSISTEDSEARCHTERMS_REVERT_BY_POPUP_COUNT 1382 1383 view_count: 1384 type: counter 1385 description: > 1386 The count of the number of times search terms persisted in the 1387 Urlbar. This gets recorded after a user loads a SERP that persists 1388 search terms, or switches back to an existing tab that should be 1389 showing the persisted search terms in the Urlbar, regardless of 1390 whether PopupNotification cleared the search terms from the Urlbar. 1391 This metric was generated to correspond to the Legacy Telemetry 1392 scalar urlbar.persistedsearchterms.view_count. 1393 bugs: 1394 - https://bugzil.la/1815971 1395 data_reviews: 1396 - https://bugzil.la/1815971 1397 notification_emails: 1398 - fx-search-telemetry@mozilla.com 1399 expires: never 1400 telemetry_mirror: URLBAR_PERSISTEDSEARCHTERMS_VIEW_COUNT 1401 1402 urlbar.zeroprefix: 1403 abandonment: 1404 type: counter 1405 description: > 1406 Counts how many times the zero-prefix urlbar results panel was 1407 abandoned. 1408 This metric was generated to correspond to the Legacy Telemetry 1409 scalar urlbar.zeroprefix.abandonment. 1410 bugs: 1411 - https://bugzil.la/1806765 1412 data_reviews: 1413 - https://bugzil.la/1806765 1414 notification_emails: 1415 - fx-search-telemetry@mozilla.com 1416 expires: never 1417 telemetry_mirror: URLBAR_ZEROPREFIX_ABANDONMENT 1418 1419 engagement: 1420 type: counter 1421 description: > 1422 Counts how many times a result was picked in the zero-prefix urlbar 1423 results panel. 1424 This metric was generated to correspond to the Legacy Telemetry 1425 scalar urlbar.zeroprefix.engagement. 1426 bugs: 1427 - https://bugzil.la/1806765 1428 data_reviews: 1429 - https://bugzil.la/1806765 1430 notification_emails: 1431 - fx-search-telemetry@mozilla.com 1432 expires: never 1433 telemetry_mirror: URLBAR_ZEROPREFIX_ENGAGEMENT 1434 1435 exposure: 1436 type: counter 1437 description: > 1438 Counts how many times the zero-prefix urlbar results panel was shown 1439 to the user. 1440 This metric was generated to correspond to the Legacy Telemetry 1441 scalar urlbar.zeroprefix.exposure. 1442 bugs: 1443 - https://bugzil.la/1806765 1444 data_reviews: 1445 - https://bugzil.la/1806765 1446 notification_emails: 1447 - fx-search-telemetry@mozilla.com 1448 expires: never 1449 telemetry_mirror: URLBAR_ZEROPREFIX_EXPOSURE 1450 1451 urlbar.quickaction: 1452 picked: 1453 type: labeled_counter 1454 description: > 1455 Counts how many times quickaction results were selected. The key is 1456 the in the form "actionkey-N" where N is the number of characters 1457 the user typed to be shown the action. 1458 This metric was generated to correspond to the Legacy Telemetry 1459 scalar quickaction.picked. 1460 bugs: 1461 - https://bugzil.la/1783155 1462 data_reviews: 1463 - https://bugzil.la/1783155 1464 notification_emails: 1465 - fx-search-telemetry@mozilla.com 1466 expires: never 1467 telemetry_mirror: QUICKACTION_PICKED 1468 1469 urlbar.unifiedsearchbutton: 1470 opened: 1471 type: counter 1472 description: > 1473 Counts how many times Unified Search Button popup is opened. 1474 This metric was generated to correspond to the Legacy Telemetry 1475 scalar urlbar.unifiedsearchbutton.opened. 1476 bugs: 1477 - https://bugzil.la/1936673 1478 data_reviews: 1479 - https://bugzil.la/1936673 1480 notification_emails: 1481 - fx-search-telemetry@mozilla.com 1482 expires: never 1483 telemetry_mirror: URLBAR_UNIFIEDSEARCHBUTTON_OPENED 1484 1485 picked: 1486 type: labeled_counter 1487 description: > 1488 Counts how many times Unified Search Button items were selected. 1489 The key is followings. 1490 * builtin_search: Builtin search engine. 1491 * addon_search: Addon search engine. 1492 * local_search: Local search engine such as Bookmarks. 1493 * settings: Settings menu. 1494 This metric was generated to correspond to the Legacy Telemetry 1495 scalar urlbar.unifiedsearchbutton.picked. 1496 bugs: 1497 - https://bugzil.la/1936673 1498 data_reviews: 1499 - https://bugzil.la/1936673 1500 notification_emails: 1501 - fx-search-telemetry@mozilla.com 1502 expires: never 1503 telemetry_mirror: URLBAR_UNIFIEDSEARCHBUTTON_PICKED 1504 1505 urlbar.merino: 1506 latency_by_response_status: 1507 type: labeled_timing_distribution 1508 description: > 1509 Duration from when the client sends a request to Merino to when the client 1510 receives a response, labeled by response status code. Labels are dynamic. 1511 For non-OHTTP requests, labels are simply the numeric status code, e.g., 1512 "200". For OHTTP requests, labels are `${status}_ohttp`, e.g., "200_ohttp". 1513 time_unit: millisecond 1514 bugs: 1515 - https://bugzil.la/1971448 1516 data_reviews: 1517 - https://bugzil.la/1971448 1518 notification_emails: 1519 - fx-search-telemetry@mozilla.com 1520 - disco-team@mozilla.com 1521 expires: never