tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

metrics.yaml (75712B)


      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 :: Search'
     12 
     13 newtab.search:
     14  issued:
     15    type: event
     16    description: >
     17      When Firefox was asked to issue a search from a Search Access Point (SAP)
     18      on a newtab page.
     19      Doesn't record searches in Private Browsing Mode unless
     20      `browser.engagement.search_counts.pbm` is set to `true`.
     21    bugs:
     22      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
     23      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
     24      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
     25    data_reviews:
     26      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
     27      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
     28      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
     29    data_sensitivity:
     30      - interaction
     31    notification_emails:
     32      - anicholson@mozilla.com
     33      - chutten@mozilla.com
     34      - mmccorquodale@mozilla.com
     35      - najiang@mozilla.com
     36      - lina@mozilla.com
     37    expires: never
     38    extra_keys:
     39      newtab_visit_id: &newtab_visit_id
     40        description: >
     41          The id of the newtab visit that originated the search.
     42          Should always be present for handoff searches.
     43          TODO(bug 1774597): for searches done without handoff (e.g. with
     44          `browser.newtabpage.activity-stream.improvesearch.handoffToAwesomebar`
     45          set to `false`), the active newtab visit id is unknown.
     46        type: string
     47      search_access_point: &search_access_point
     48        description: >
     49          One of the search access points available on the new tab like
     50          * `urlbar_handoff`
     51          * `about_home`
     52          * `about_newtab`
     53        type: string
     54      telemetry_id: &telemetry_id
     55        description: >
     56          The search engine's `telemetryId`, like `google-b-d`.
     57          This is set to be a telemetry-specific id for config engines,
     58          and is `other-<name>` for others (where `<name>` is the engine's
     59          WebExtension name).
     60        type: string
     61    send_in_pings:
     62      - newtab
     63 
     64 newtab.search.ad:
     65  impression:
     66    type: event
     67    description: >
     68      Recorded when a newtab visit resulted in a search that
     69      loaded a Search Engine Result Page (SERP) that contains an ad link.
     70      And the SERP is visible.
     71    bugs:
     72      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
     73      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
     74      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
     75    data_reviews:
     76      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
     77      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
     78      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
     79    data_sensitivity:
     80      - interaction
     81    notification_emails:
     82      - anicholson@mozilla.com
     83      - chutten@mozilla.com
     84      - mmccorquodale@mozilla.com
     85      - najiang@mozilla.com
     86      - lina@mozilla.com
     87    expires: never
     88    extra_keys:
     89      newtab_visit_id: *newtab_visit_id
     90      search_access_point: *search_access_point
     91      is_follow_on: &is_follow_on
     92        description: >
     93          Whether the preceding search happened on a search results page.
     94        type: boolean
     95      is_tagged: &is_tagged
     96        description: >
     97          Whether the preceding search was tagged with a partner code.
     98        type: boolean
     99      telemetry_id: *telemetry_id
    100    send_in_pings:
    101      - newtab
    102 
    103  click:
    104    type: event
    105    description: >
    106      Recorded when an ad link is clicked on a Search Engine Result Page (SERP)
    107      which was loaded by a seach that began on a newtab page.
    108    bugs:
    109      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
    110      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
    111      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    112    data_reviews:
    113      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
    114      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
    115      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    116    data_sensitivity:
    117      - interaction
    118    notification_emails:
    119      - anicholson@mozilla.com
    120      - chutten@mozilla.com
    121      - mmccorquodale@mozilla.com
    122      - najiang@mozilla.com
    123      - lina@mozilla.com
    124    expires: never
    125    extra_keys:
    126      newtab_visit_id: *newtab_visit_id
    127      search_access_point: *search_access_point
    128      is_follow_on: *is_follow_on
    129      is_tagged: *is_tagged
    130      telemetry_id: *telemetry_id
    131    send_in_pings:
    132      - newtab
    133 
    134 sap:
    135  counts:
    136    type: event
    137    description: >
    138      Recorded search counts when a user initiates a search from a search access
    139      point (SAP). It does not guarantee that the search engine result page was
    140      loaded successfully (use SERP telemetry).
    141    bugs:
    142      - https://bugzilla.mozilla.org/show_bug.cgi?id=1938929
    143    data_reviews:
    144      - https://bugzilla.mozilla.org/show_bug.cgi?id=1938929
    145    data_sensitivity:
    146      - interaction
    147    notification_emails:
    148      - fx-search-telemetry@mozilla.com
    149      - rev-data@mozilla.com
    150    expires: never
    151    extra_keys:
    152      source:
    153        description: >
    154          The search access point from which the user initiated the search.
    155          Possible values are:
    156          `about_home`,
    157          `contextmenu`,
    158          `contextmenu_visual`,
    159          `about_newtab`,
    160          `searchbar`,
    161          `system`,
    162          `urlbar`,
    163          `urlbar_handoff`,
    164          `urlbar_persisted`,
    165          `urlbar_searchmode`,
    166          `webextension`
    167          `aiwindow_assistant`
    168 
    169          Prior to Firefox 142, the possible source values were:
    170          `abouthome`, `contextmenu`, `newtab`, `searchbar`, `system`, `urlbar`,
    171          `urlbar-handoff`, `urlbar-persisted`, `urlbar-searchmode`, `webextension`
    172 
    173          These were changed to be consistent with other search telemetry reporting.
    174        type: string
    175      provider_id:
    176        description: >
    177          The identifier of the search engine provider that is being used for the
    178          search. Note this may be different to the identifier of the provider in
    179          SERP reports. For user installed engines, this will be the string `other`.
    180        type: string
    181      provider_name:
    182        description: >
    183          The name of the search engine provider that is being used for the search.
    184        type: string
    185      partner_code:
    186        description: >
    187          The partner code, if defined/known, that is being used for the search.
    188          Not all search engines have partner codes. May be empty for engines that
    189          are overridden by a third-party add-on or OpenSearch engine.
    190        type: string
    191      overridden_by_third_party:
    192        description: >
    193          Set to true if the search engine has been allowed to be overridden by
    194          a third-party add-on or OpenSearch engine.
    195        type: boolean
    196 
    197  deprecated_counts:
    198    type: labeled_counter
    199    description: >
    200      This is deprecated metric that should not be incoporated into dashboards.
    201      Use the `sap.counts` event instead.
    202 
    203      This metric has been added to Glean to aid transition of
    204      histograms and allow the legacy telemetry SEARCH_COUNTS to continue to be
    205      recorded.
    206 
    207      Records search counts for search access points. The format is:
    208      <engine-name>.<search-access-point>. For the urlbar when in search mode,
    209      the format is <engine name>.urlbar-searchmode. For the urlbar when an
    210      internal @engine shortcut is used, the format is: <engine-name>.alias.
    211 
    212      This metric was generated to correspond to the Legacy Telemetry count
    213      histogram SEARCH_COUNTS.
    214    bugs:
    215      - https://bugzilla.mozilla.org/show_bug.cgi?id=1089670
    216      - https://bugzilla.mozilla.org/show_bug.cgi?id=1475571
    217      - https://bugzilla.mozilla.org/show_bug.cgi?id=1482158
    218      - https://bugzilla.mozilla.org/show_bug.cgi?id=1499193
    219      - https://bugzilla.mozilla.org/show_bug.cgi?id=1545172
    220      - https://bugzilla.mozilla.org/show_bug.cgi?id=1572500
    221      - https://bugzilla.mozilla.org/show_bug.cgi?id=1654680
    222    data_reviews:
    223      - https://bugzilla.mozilla.org/show_bug.cgi?id=1089670
    224      - https://bugzilla.mozilla.org/show_bug.cgi?id=1475571
    225      - https://bugzilla.mozilla.org/show_bug.cgi?id=1482158
    226      - https://bugzilla.mozilla.org/show_bug.cgi?id=1499193
    227      - https://bugzilla.mozilla.org/show_bug.cgi?id=1545172
    228      - https://bugzilla.mozilla.org/show_bug.cgi?id=1572500
    229      - https://bugzilla.mozilla.org/show_bug.cgi?id=1654680
    230    notification_emails:
    231      - fx-search-telemetry@mozilla.com
    232      - rev-data@mozilla.com
    233    expires: never
    234    telemetry_mirror: h#SEARCH_COUNTS
    235 
    236  search_form_counts:
    237    type: event
    238    description: >
    239      Records how often users visit the homepages of search engines (also
    240      known as SearchForm) using a SAP. It only counts how many visits were
    241      initiated, not how many homepages were loaded successfully.
    242    bugs:
    243      - https://bugzilla.mozilla.org/show_bug.cgi?id=1915252
    244    data_reviews:
    245      - https://bugzilla.mozilla.org/show_bug.cgi?id=1915252
    246    data_sensitivity:
    247      - interaction
    248    notification_emails:
    249      - fx-search-telemetry@mozilla.com
    250    expires: never
    251    extra_keys:
    252      source:
    253        description: >
    254          The search access point from which the user initiated the search.
    255          Possible values are `searchbar` and `urlbar`.
    256        type: string
    257      provider_id:
    258        description: >
    259          The identifier of the search engine provider that is being used for the
    260          search. Note this may be different to the identifier of the provider in
    261          SERP reports. For user installed engines, this will be the string `other`.
    262        type: string
    263 
    264 sap.impression_counts:
    265  contextmenu_visual:
    266    type: labeled_counter
    267    description: >
    268      Count of impressions of the visual search context menu item. The counter's
    269      label is the engine's identifier if the engine is known at the time of
    270      impression and it's an app-provided engine. Otherwise the label is "none".
    271    data_sensitivity:
    272      - interaction
    273    bugs:
    274      - https://bugzil.la/1979224
    275    data_reviews:
    276      - https://bugzil.la/1979224
    277    notification_emails:
    278      - fx-search-telemetry@mozilla.com
    279      - rev-data@mozilla.com
    280    expires: never
    281 
    282 serp:
    283  impression:
    284    type: event
    285    description: >
    286      Recorded when a search engine results page (SERP) is shown to a user.
    287      The feature began rolling out to all users with Firefox 115, and was
    288      permanently enabled in Firefox 119.
    289    bugs:
    290      - https://bugzilla.mozilla.org/show_bug.cgi?id=1813162
    291      - https://bugzilla.mozilla.org/show_bug.cgi?id=1824543
    292      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816736
    293      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816738
    294      - https://bugzilla.mozilla.org/show_bug.cgi?id=1829953
    295      - https://bugzilla.mozilla.org/show_bug.cgi?id=1851495
    296    data_reviews:
    297      - https://bugzilla.mozilla.org/show_bug.cgi?id=1813162
    298      - https://bugzilla.mozilla.org/show_bug.cgi?id=1824543
    299      - https://bugzilla.mozilla.org/show_bug.cgi?id=1851495
    300    data_sensitivity:
    301      - interaction
    302    notification_emails:
    303      - fx-search-telemetry@mozilla.com
    304      - rev-data@mozilla.com
    305    expires: never
    306    extra_keys:
    307      impression_id: &impression_id
    308        description: >
    309          A uuid to link SERP events to user's engagement events.
    310        type: string
    311      provider:
    312        description: >
    313          The name of the provider.
    314        type: string
    315      tagged:
    316        description: >
    317          Whether the search is tagged (true) or organic (false).
    318        type: boolean
    319      partner_code:
    320        description: >
    321          Any partner_code parsing in the URL or an empty string if not
    322          available.
    323        type: string
    324      source:
    325        description: >
    326          How the user arrived at the SERP. A value of `unknown` means we can't
    327          determine the source. The possible values are:
    328          `contextmenu`,
    329          `contextmenu_visual`,
    330          `follow_on_from_refine_on_incontent_search`,
    331          `follow_on_from_refine_on_SERP`,
    332          `opened_in_new_tab`,
    333          `reload`,
    334          `searchbar`,
    335          `system`,
    336          `urlbar`,
    337          `urlbar_handoff`,
    338          `urlbar_persisted`,
    339          `urlbar_searchmode`,
    340          `tabhistory`,
    341          `unknown`,
    342          `webextension`
    343          `aiwindow_assistant`
    344        type: string
    345      search_mode:
    346        description: >
    347          The mode which the search page is in. If it is in the normal search
    348          mode, then no value is reported. Possible values are:
    349          `image_search`.
    350        type: string
    351      shopping_tab_displayed:
    352        description:
    353          Indicates if the shopping tab is displayed.
    354        type: boolean
    355      is_shopping_page:
    356        description:
    357          Indicates if the page is a shopping page.
    358        type: boolean
    359      is_private:
    360        description:
    361          Indicates if the page was loaded while in Private Browsing Mode.
    362          Added in Firefox 120.
    363        type: boolean
    364      is_signed_in:
    365        description:
    366          Indicates if the page was loaded while the user is signed in to a
    367          provider's account. Added in Firefox 127.
    368        type: boolean
    369 
    370  engagement:
    371    type: event
    372    description: >
    373      Recorded user actions on a SERP.
    374    bugs:
    375      - https://bugzilla.mozilla.org/show_bug.cgi?id=1814773
    376      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816730
    377      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816735
    378      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849371
    379      - https://bugzilla.mozilla.org/show_bug.cgi?id=1901839
    380    data_reviews:
    381      - https://bugzilla.mozilla.org/show_bug.cgi?id=1814773
    382      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816730
    383      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849371
    384    data_sensitivity:
    385      - interaction
    386    notification_emails:
    387      - fx-search-telemetry@mozilla.com
    388      - rev-data@mozilla.com
    389    expires: never
    390    extra_keys:
    391      impression_id: *impression_id
    392      action:
    393        description: >
    394          The action taken on the page.
    395          Possible values are:
    396          `clicked`,
    397          `clicked_accept`,
    398          `clicked_reject`,
    399          `clicked_more_options`,
    400          `expanded`,
    401          `submitted`.
    402        type: string
    403      target:
    404        description: >
    405          The target component used to trigger the action.
    406          Possible values are:
    407          `ad_carousel`,
    408          `ad_image_row`,
    409          `ad_link`,
    410          `ad_popover`,
    411          `ad_sidebar`,
    412          `ad_sitelink`,
    413          `ad_uncategorized` (added in Firefox 129),
    414          `cookie_banner`,
    415          `incontent_searchbox`,
    416          `non_ads_link`,
    417          `refined_search_buttons`,
    418          `shopping_tab`.
    419          `ad_uncategorized` are likely the result of an engagement with an ad
    420          loaded after the page was categorized for components (e.g. infinite
    421          scrolling).
    422        type: string
    423 
    424  ad_impression:
    425    type: event
    426    description: >
    427      Recorded when a user loads a SERP and ads are detected.
    428    bugs:
    429      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816728
    430      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816729
    431      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849371
    432      - https://bugzilla.mozilla.org/show_bug.cgi?id=1909979
    433    data_reviews:
    434      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816728
    435      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849371
    436      - https://phabricator.services.mozilla.com/D217999
    437    data_sensitivity:
    438      - interaction
    439    notification_emails:
    440      - fx-search-telemetry@mozilla.com
    441      - rev-data@mozilla.com
    442    expires: never
    443    extra_keys:
    444      impression_id: *impression_id
    445      component:
    446        description: >
    447          Type of components on a SERP. Possible values are:
    448          `ad_carousel`,
    449          `ad_image_row`,
    450          `ad_link`,
    451          `ad_popover`,
    452          `ad_sidebar`,
    453          `ad_sitelink`,
    454          `cookie_banner`,
    455          `refined_search_buttons`,
    456          `shopping_tab`.
    457          Defaults to `ad_link`. `ad_popover` was added as a temporary component
    458          in August 2024 as a response to clients reporting an extra hidden ad
    459          and stopped being reported in telemetry with Firefox 131 as the
    460          version added the ability to categorize links but not report them in
    461          telemetry.
    462        type: string
    463      ads_loaded:
    464        description: >
    465          Number of ads loaded for this component. They may or
    466          may not be visible on the page.
    467        type: quantity
    468      ads_visible:
    469        description: >
    470          Number of ads visible for this component. An ad can be
    471          considered visible if was within the browser window
    472          by the time the impression was recorded.
    473        type: quantity
    474      ads_hidden:
    475        description: >
    476          Number of ads hidden for this component. These are ads that
    477          are loaded in the DOM but hidden via CSS and/or Javascript.
    478        type: quantity
    479 
    480  abandonment:
    481    type: event
    482    description: >
    483      Recorded when there is no engagement with the SERP before the tab is
    484      closed, the window is closed, the app is closed, or the tab is navigated
    485      away from.
    486    bugs:
    487      - https://bugzilla.mozilla.org/show_bug.cgi?id=1814776
    488    data_reviews:
    489      - https://bugzilla.mozilla.org/show_bug.cgi?id=1814776
    490    data_sensitivity:
    491      - interaction
    492    notification_emails:
    493      - fx-search-telemetry@mozilla.com
    494      - rev-data@mozilla.com
    495    expires: never
    496    extra_keys:
    497      impression_id: *impression_id
    498      reason:
    499        description: >
    500          Why the SERP is deemed abandoned.
    501          Possible values are:
    502          `tab_close`, `window_close`, `navigation`
    503        type: string
    504 
    505  categorization_duration:
    506    type: timing_distribution
    507    time_unit: millisecond
    508    description: >
    509      The time it takes to categorize elements on a SERP.
    510    bugs:
    511      - https://bugzilla.mozilla.org/show_bug.cgi?id=1834100
    512    data_reviews:
    513      - https://bugzilla.mozilla.org/show_bug.cgi?id=1834100
    514    data_sensitivity:
    515      - technical
    516    notification_emails:
    517      - fx-search-telemetry@mozilla.com
    518    expires: never
    519 
    520  categorization:
    521    type: event
    522    description: >
    523      A high-level categorization of a SERP (a best guess as to its topic),
    524      using buckets such as "sports" or "travel".
    525    bugs:
    526      - https://bugzilla.mozilla.org/show_bug.cgi?id=1868476
    527      - https://bugzilla.mozilla.org/show_bug.cgi?id=1869064
    528      - https://bugzilla.mozilla.org/show_bug.cgi?id=1887686
    529      - https://bugzilla.mozilla.org/show_bug.cgi?id=1892267
    530    data_reviews:
    531      - https://bugzilla.mozilla.org/show_bug.cgi?id=1868476
    532    data_sensitivity:
    533      - stored_content
    534    notification_emails:
    535      - fx-search-telemetry@mozilla.com
    536      - rev-data@mozilla.com
    537    expires: never
    538    extra_keys:
    539      sponsored_category:
    540        description: >
    541          An index corresponding to a broad category for the SERP, derived from
    542          sponsored domains.
    543        type: quantity
    544      sponsored_num_domains:
    545        description: >
    546          The total number of sponsored domains used in the categorization
    547          process for the SERP.
    548        type: quantity
    549      sponsored_num_unknown:
    550        description: >
    551          The count of sponsored domains extracted from the SERP that are not
    552          found in the domain-to-categories mapping.
    553        type: quantity
    554      sponsored_num_inconclusive:
    555        description: >
    556          The count of sponsored domains extracted from the SERP that are found
    557          in the domain-to-categories mapping but are deemed inconclusive.
    558        type: quantity
    559      organic_category:
    560        description: >
    561          An index corresponding to a broad category for the SERP, derived from
    562          organic domains.
    563        type: quantity
    564      organic_num_domains:
    565        description: >
    566          The total number of organic domains used in the categorization
    567          process for the SERP.
    568        type: quantity
    569      organic_num_unknown:
    570        description: >
    571          The count of organic domains extracted from the SERP that are not
    572          found in the domain-to-categories mapping.
    573        type: quantity
    574      organic_num_inconclusive:
    575        description: >
    576          The count of organic domains extracted from the SERP that are found
    577          in the domain-to-categories mapping but are deemed inconclusive.
    578        type: quantity
    579      region:
    580        description: >
    581          A two-letter country code indicating where the SERP was loaded.
    582        type: string
    583      channel:
    584        description: >
    585          The type of update channel, for example: “nightly”, “beta”, “release”.
    586        type: string
    587      provider:
    588        description: >
    589          The name of the provider.
    590        type: string
    591      tagged:
    592        description: >
    593          Whether the search is tagged (true) or organic (false).
    594        type: boolean
    595      partner_code:
    596        description: >
    597          Any partner_code parsing in the URL or an empty string if not
    598          available.
    599        type: string
    600      app_version:
    601        description: >
    602          The Firefox major version used, for example: 126.
    603        type: quantity
    604      mappings_version:
    605        description: >
    606          Version number for the Remote Settings attachments used to generate
    607          the domain-to-categories map used in the SERP categorization process.
    608        type: quantity
    609      is_shopping_page:
    610        description: >
    611          Indicates if the page is a shopping page.
    612        type: boolean
    613      num_ads_hidden:
    614        description: >
    615          Number of ads hidden on the page at the time of categorizing the
    616          page.
    617        type: quantity
    618      num_ads_loaded:
    619        description: >
    620          Number of ads loaded on the page at the time of categorizing the
    621          page.
    622        type: quantity
    623      num_ads_visible:
    624        description: >
    625          Number of ads visible on the page at the time of categorizing the
    626          page.
    627        type: quantity
    628      num_ads_clicked:
    629        description: >
    630          Number of ads clicked on the page.
    631        type: quantity
    632    send_in_pings:
    633      - serp-categorization
    634 
    635  ads_blocked_count:
    636    type: labeled_counter
    637    description: >
    638      Counts the specific type of block.
    639    bugs:
    640      - https://bugzilla.mozilla.org/show_bug.cgi?id=1907097
    641    data_reviews:
    642      - https://phabricator.services.mozilla.com/D216208
    643    notification_emails:
    644      - fx-search-telemetry@mozilla.com
    645      - rev-data@mozilla.com
    646    expires: never
    647    data_sensitivity:
    648      - technical
    649    labels:
    650      - beyond_viewport
    651      - hidden_parent
    652      - hidden_child
    653 
    654  experiment_info:
    655    type: object
    656    description: >
    657      Whether the client is enrolled in a specified experiment and if so, which
    658      branch the client is assigned to. The target experiment is specified in
    659      the Nimbus config by creating a "targetExperiment" key and setting its
    660      value to the experiment's slug (and ensuring the featureId is "search").
    661    bugs:
    662      - https://bugzilla.mozilla.org/show_bug.cgi?id=1879667
    663    data_reviews:
    664      - https://bugzilla.mozilla.org/show_bug.cgi?id=1868476
    665    data_sensitivity:
    666      - technical
    667    notification_emails:
    668      - fx-search-telemetry@mozilla.com
    669      - rev-data@mozilla.com
    670    expires: never
    671    structure:
    672      type: object
    673      properties:
    674        slug:
    675          type: string
    676        branch:
    677          type: string
    678    send_in_pings:
    679      - serp-categorization
    680 
    681  categorization_no_map_found:
    682    type: counter
    683    description: >
    684      A count incremented upon a SERP categorization event being recorded
    685      without a corresponding impression event being recorded. This metric
    686      effectively counts missing impressions due to issues with the
    687      domain-to-categories map.
    688    bugs:
    689      - https://bugzilla.mozilla.org/show_bug.cgi?id=1900094
    690    data_reviews:
    691      - https://phabricator.services.mozilla.com/D214868
    692    data_sensitivity:
    693      - technical
    694    notification_emails:
    695      - fx-search-telemetry@mozilla.com
    696      - rev-data@mozilla.com
    697    expires: never
    698    send_in_pings:
    699      - serp-categorization
    700 
    701 search_with:
    702  reporting_url:
    703    type: url
    704    description: >
    705      The external url to report this interaction to.
    706    bugs:
    707      - https://bugzilla.mozilla.org/show_bug.cgi?id=1870138
    708    data_reviews:
    709      - https://bugzilla.mozilla.org/show_bug.cgi?id=1870138
    710    data_sensitivity:
    711      - web_activity
    712    notification_emails:
    713      - mkaply@mozilla.com
    714    expires: never
    715    send_in_pings:
    716      - search-with
    717 
    718  context_id:
    719    type: uuid
    720    description: >
    721      An identifier for Contextual Services user interaction pings. This is
    722      used internally for counting unique users as well as for anti-fraud. It
    723      is shared with other Contextual Services. It is not shared externally.
    724    bugs:
    725      - https://bugzilla.mozilla.org/show_bug.cgi?id=1870138
    726    data_reviews:
    727      - https://bugzilla.mozilla.org/show_bug.cgi?id=1870138#c3
    728    data_sensitivity:
    729      - technical
    730    notification_emails:
    731      - mkaply@mozilla.com
    732    expires: never
    733    send_in_pings:
    734      - search-with
    735 
    736 browser.engagement.navigation:
    737  urlbar:
    738    type: labeled_counter
    739    description: >
    740      The count URI loads triggered in a subsession from the urlbar,
    741      broken down by the originating action.
    742      This metric was generated to correspond to the Legacy Telemetry
    743      scalar browser.engagement.navigation.urlbar.
    744    bugs:
    745      - https://bugzil.la/1271313
    746    data_reviews:
    747      - https://bugzil.la/1271313
    748    notification_emails:
    749      - fx-search-telemetry@mozilla.com
    750      - rev-data@mozilla.com
    751    expires: never
    752    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_URLBAR
    753 
    754  urlbar_handoff:
    755    type: labeled_counter
    756    description: >
    757      The count URI loads triggered in a subsession from the urlbar via
    758      handoff, broken down by the originating action.
    759      This metric was generated to correspond to the Legacy Telemetry
    760      scalar browser.engagement.navigation.urlbar_handoff.
    761    bugs:
    762      - https://bugzil.la/1732429
    763    data_reviews:
    764      - https://bugzil.la/1732429
    765    notification_emails:
    766      - fx-search-telemetry@mozilla.com
    767      - rev-data@mozilla.com
    768    expires: never
    769    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_URLBAR_HANDOFF
    770 
    771  urlbar_persisted:
    772    type: labeled_counter
    773    description: >
    774      The count of URI loads triggered in a subsession from the urlbar
    775      after the search term was shown in the urlbar, broken down by the
    776      originating action.
    777      This metric was generated to correspond to the Legacy Telemetry
    778      scalar browser.engagement.navigation.urlbar_persisted.
    779    bugs:
    780      - https://bugzil.la/1779471
    781    data_reviews:
    782      - https://bugzil.la/1779471
    783    notification_emails:
    784      - fx-search-telemetry@mozilla.com
    785      - rev-data@mozilla.com
    786    expires: never
    787    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_URLBAR_PERSISTED
    788 
    789  urlbar_searchmode:
    790    type: labeled_counter
    791    description: >
    792      The count URI loads triggered in a subsession from the urlbar's
    793      search mode, broken down by the originating action.
    794      This metric was generated to correspond to the Legacy Telemetry
    795      scalar browser.engagement.navigation.urlbar_searchmode.
    796    bugs:
    797      - https://bugzil.la/1654680
    798    data_reviews:
    799      - https://bugzil.la/1654680
    800    notification_emails:
    801      - fx-search-telemetry@mozilla.com
    802      - rev-data@mozilla.com
    803    expires: never
    804    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_URLBAR_SEARCHMODE
    805 
    806  searchbar:
    807    type: labeled_counter
    808    description: >
    809      The count URI loads triggered in a subsession from the searchbar,
    810      broken down by the originating action.
    811      This metric was generated to correspond to the Legacy Telemetry
    812      scalar browser.engagement.navigation.searchbar.
    813    bugs:
    814      - https://bugzil.la/1271313
    815    data_reviews:
    816      - https://bugzil.la/1271313
    817    notification_emails:
    818      - fx-search-telemetry@mozilla.com
    819      - rev-data@mozilla.com
    820    expires: never
    821    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_SEARCHBAR
    822 
    823  about_home:
    824    type: labeled_counter
    825    description: >
    826      The count URI loads triggered in a subsession from about:home,
    827      broken down by the originating action.
    828      This metric was generated to correspond to the Legacy Telemetry
    829      scalar browser.engagement.navigation.about_home.
    830    bugs:
    831      - https://bugzil.la/1271313
    832    data_reviews:
    833      - https://bugzil.la/1271313
    834    notification_emails:
    835      - fx-search-telemetry@mozilla.com
    836      - rev-data@mozilla.com
    837    expires: never
    838    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_ABOUT_HOME
    839 
    840  about_newtab:
    841    type: labeled_counter
    842    description: >
    843      The count URI loads triggered in a subsession from about:newtab,
    844      broken down by the originating action.
    845      This metric was generated to correspond to the Legacy Telemetry
    846      scalar browser.engagement.navigation.about_newtab.
    847    bugs:
    848      - https://bugzil.la/1271313
    849    data_reviews:
    850      - https://bugzil.la/1271313
    851    notification_emails:
    852      - fx-search-telemetry@mozilla.com
    853      - rev-data@mozilla.com
    854    expires: never
    855    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_ABOUT_NEWTAB
    856 
    857  contextmenu:
    858    type: labeled_counter
    859    description: >
    860      The count URI loads triggered in a subsession from the contextmenu,
    861      broken down by the originating action.
    862      This metric was generated to correspond to the Legacy Telemetry
    863      scalar browser.engagement.navigation.contextmenu.
    864    bugs:
    865      - https://bugzil.la/1271313
    866    data_reviews:
    867      - https://bugzil.la/1271313
    868    notification_emails:
    869      - fx-search-telemetry@mozilla.com
    870      - rev-data@mozilla.com
    871    expires: never
    872    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_CONTEXTMENU
    873 
    874  contextmenu_visual:
    875    type: labeled_counter
    876    description: >
    877      The count of URI loads triggered in a subsession from the context menu's
    878      visual search menuitem, broken down by the originating action.
    879    data_sensitivity:
    880      - interaction
    881    bugs:
    882      - https://bugzil.la/1979211
    883    data_reviews:
    884      - https://bugzil.la/1979211
    885    notification_emails:
    886      - fx-search-telemetry@mozilla.com
    887      - rev-data@mozilla.com
    888    expires: never
    889 
    890  webextension:
    891    type: labeled_counter
    892    description: >
    893      The count URI loads triggered in a subsession from a webextension.
    894      This metric was generated to correspond to the Legacy Telemetry
    895      scalar browser.engagement.navigation.webextension.
    896    bugs:
    897      - https://bugzil.la/1492233
    898    data_reviews:
    899      - https://bugzil.la/1492233
    900    notification_emails:
    901      - fx-search-telemetry@mozilla.com
    902      - rev-data@mozilla.com
    903    expires: never
    904    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_WEBEXTENSION
    905 
    906  aiwindow_assistant:
    907    type: labeled_counter
    908    description: >
    909      The count URI loads triggered in a subsession from the AI window assistant
    910      search handoff button.
    911    bugs:
    912      - https://bugzil.la/2001519
    913    data_reviews:
    914      - https://bugzil.la/2001519
    915    notification_emails:
    916      - fx-search-telemetry@mozilla.com
    917      - rev-data@mozilla.com
    918    expires: never
    919 
    920 browser.search.content:
    921  urlbar:
    922    type: labeled_counter
    923    description: >
    924      Records counts for in-content searches where the search was most
    925      likely started from the urlbar. The key format is
    926      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
    927      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
    928      This metric was generated to correspond to the Legacy Telemetry
    929      scalar browser.search.content.urlbar.
    930    bugs:
    931      - https://bugzil.la/1089670
    932      - https://bugzil.la/1475571
    933      - https://bugzil.la/1482158
    934      - https://bugzil.la/1545172
    935      - https://bugzil.la/1634564
    936    data_reviews:
    937      - https://bugzil.la/1089670
    938      - https://bugzil.la/1475571
    939      - https://bugzil.la/1482158
    940      - https://bugzil.la/1545172
    941      - https://bugzil.la/1634564
    942    notification_emails:
    943      - fx-search-telemetry@mozilla.com
    944      - rev-data@mozilla.com
    945    expires: never
    946    telemetry_mirror: BROWSER_SEARCH_CONTENT_URLBAR
    947 
    948  urlbar_handoff:
    949    type: labeled_counter
    950    description: >
    951      The count URI loads triggered in a subsession from the urlbar via
    952      handoff, broken down by the originating action.
    953      This metric was generated to correspond to the Legacy Telemetry
    954      scalar browser.search.content.urlbar_handoff.
    955    bugs:
    956      - https://bugzil.la/1732429
    957    data_reviews:
    958      - https://bugzil.la/1732429
    959    notification_emails:
    960      - fx-search-telemetry@mozilla.com
    961      - rev-data@mozilla.com
    962    expires: never
    963    telemetry_mirror: BROWSER_SEARCH_CONTENT_URLBAR_HANDOFF
    964 
    965  urlbar_persisted:
    966    type: labeled_counter
    967    description: >
    968      Records counts for in-content searches where the search was most
    969      likely started from the urlbar after the search term was shown in
    970      the urlbar. The key format is
    971      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
    972      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
    973      This metric was generated to correspond to the Legacy Telemetry
    974      scalar browser.search.content.urlbar_persisted.
    975    bugs:
    976      - https://bugzil.la/1779471
    977    data_reviews:
    978      - https://bugzil.la/1779471
    979    notification_emails:
    980      - fx-search-telemetry@mozilla.com
    981      - rev-data@mozilla.com
    982    expires: never
    983    telemetry_mirror: BROWSER_SEARCH_CONTENT_URLBAR_PERSISTED
    984 
    985  urlbar_searchmode:
    986    type: labeled_counter
    987    description: >
    988      Records counts for in-content searches where the search was most
    989      likely started from the urlbar in search mode. The key format is
    990      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
    991      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
    992      This metric was generated to correspond to the Legacy Telemetry
    993      scalar browser.search.content.urlbar_searchmode.
    994    bugs:
    995      - https://bugzil.la/1089670
    996      - https://bugzil.la/1475571
    997      - https://bugzil.la/1482158
    998      - https://bugzil.la/1545172
    999      - https://bugzil.la/1634564
   1000    data_reviews:
   1001      - https://bugzil.la/1089670
   1002      - https://bugzil.la/1475571
   1003      - https://bugzil.la/1482158
   1004      - https://bugzil.la/1545172
   1005      - https://bugzil.la/1634564
   1006    notification_emails:
   1007      - fx-search-telemetry@mozilla.com
   1008      - rev-data@mozilla.com
   1009    expires: never
   1010    telemetry_mirror: BROWSER_SEARCH_CONTENT_URLBAR_SEARCHMODE
   1011 
   1012  searchbar:
   1013    type: labeled_counter
   1014    description: >
   1015      Records counts for in-content searches where the search was most
   1016      likely started from the search bar. The key format is
   1017      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
   1018      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1019      This metric was generated to correspond to the Legacy Telemetry
   1020      scalar browser.search.content.searchbar.
   1021    bugs:
   1022      - https://bugzil.la/1089670
   1023      - https://bugzil.la/1475571
   1024      - https://bugzil.la/1482158
   1025      - https://bugzil.la/1545172
   1026      - https://bugzil.la/1634564
   1027    data_reviews:
   1028      - https://bugzil.la/1089670
   1029      - https://bugzil.la/1475571
   1030      - https://bugzil.la/1482158
   1031      - https://bugzil.la/1545172
   1032      - https://bugzil.la/1634564
   1033    notification_emails:
   1034      - fx-search-telemetry@mozilla.com
   1035      - rev-data@mozilla.com
   1036    expires: never
   1037    telemetry_mirror: BROWSER_SEARCH_CONTENT_SEARCHBAR
   1038 
   1039  about_home:
   1040    type: labeled_counter
   1041    description: >
   1042      Records counts for in-content searches where the search was most
   1043      likely started from the about:home. The key format is
   1044      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
   1045      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1046      This metric was generated to correspond to the Legacy Telemetry
   1047      scalar browser.search.content.about_home.
   1048    bugs:
   1049      - https://bugzil.la/1089670
   1050      - https://bugzil.la/1475571
   1051      - https://bugzil.la/1482158
   1052      - https://bugzil.la/1545172
   1053      - https://bugzil.la/1634564
   1054    data_reviews:
   1055      - https://bugzil.la/1089670
   1056      - https://bugzil.la/1475571
   1057      - https://bugzil.la/1482158
   1058      - https://bugzil.la/1545172
   1059      - https://bugzil.la/1634564
   1060    notification_emails:
   1061      - fx-search-telemetry@mozilla.com
   1062      - rev-data@mozilla.com
   1063    expires: never
   1064    telemetry_mirror: BROWSER_SEARCH_CONTENT_ABOUT_HOME
   1065 
   1066  about_newtab:
   1067    type: labeled_counter
   1068    description: >
   1069      Records counts for in-content searches where the search was most
   1070      likely started from the about:newtab. The key format is
   1071      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
   1072      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1073      This metric was generated to correspond to the Legacy Telemetry
   1074      scalar browser.search.content.about_newtab.
   1075    bugs:
   1076      - https://bugzil.la/1089670
   1077      - https://bugzil.la/1475571
   1078      - https://bugzil.la/1482158
   1079      - https://bugzil.la/1545172
   1080      - https://bugzil.la/1634564
   1081    data_reviews:
   1082      - https://bugzil.la/1089670
   1083      - https://bugzil.la/1475571
   1084      - https://bugzil.la/1482158
   1085      - https://bugzil.la/1545172
   1086      - https://bugzil.la/1634564
   1087    notification_emails:
   1088      - fx-search-telemetry@mozilla.com
   1089      - rev-data@mozilla.com
   1090    expires: never
   1091    telemetry_mirror: BROWSER_SEARCH_CONTENT_ABOUT_NEWTAB
   1092 
   1093  contextmenu:
   1094    type: labeled_counter
   1095    description: >
   1096      Records counts for in-content searches where the search was most
   1097      likely started from the context menu. The key format is
   1098      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
   1099      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1100      This metric was generated to correspond to the Legacy Telemetry
   1101      scalar browser.search.content.contextmenu.
   1102    bugs:
   1103      - https://bugzil.la/1089670
   1104      - https://bugzil.la/1475571
   1105      - https://bugzil.la/1482158
   1106      - https://bugzil.la/1545172
   1107      - https://bugzil.la/1634564
   1108    data_reviews:
   1109      - https://bugzil.la/1089670
   1110      - https://bugzil.la/1475571
   1111      - https://bugzil.la/1482158
   1112      - https://bugzil.la/1545172
   1113      - https://bugzil.la/1634564
   1114    notification_emails:
   1115      - fx-search-telemetry@mozilla.com
   1116      - rev-data@mozilla.com
   1117    expires: never
   1118    telemetry_mirror: BROWSER_SEARCH_CONTENT_CONTEXTMENU
   1119 
   1120  contextmenu_visual:
   1121    type: labeled_counter
   1122    description: >
   1123      Records counts for in-content visual searches where the search was most
   1124      likely started from the context menu. The key format is the same as for
   1125      the `contextmenu` labeled counter.
   1126    data_sensitivity:
   1127      - interaction
   1128    bugs:
   1129      - https://bugzil.la/1979211
   1130    data_reviews:
   1131      - https://bugzil.la/1979211
   1132    notification_emails:
   1133      - fx-search-telemetry@mozilla.com
   1134      - rev-data@mozilla.com
   1135    expires: never
   1136 
   1137  webextension:
   1138    type: labeled_counter
   1139    description: >
   1140      Records counts for in-content searches where the search was most
   1141      likely started from a webextension. The key format is
   1142      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
   1143      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1144      This metric was generated to correspond to the Legacy Telemetry
   1145      scalar browser.search.content.webextension.
   1146    bugs:
   1147      - https://bugzil.la/1089670
   1148      - https://bugzil.la/1475571
   1149      - https://bugzil.la/1482158
   1150      - https://bugzil.la/1545172
   1151      - https://bugzil.la/1634564
   1152    data_reviews:
   1153      - https://bugzil.la/1089670
   1154      - https://bugzil.la/1475571
   1155      - https://bugzil.la/1482158
   1156      - https://bugzil.la/1545172
   1157      - https://bugzil.la/1634564
   1158    notification_emails:
   1159      - fx-search-telemetry@mozilla.com
   1160      - rev-data@mozilla.com
   1161    expires: never
   1162    telemetry_mirror: BROWSER_SEARCH_CONTENT_WEBEXTENSION
   1163 
   1164  aiwindow_assistant:
   1165    type: labeled_counter
   1166    description: >
   1167      Records counts for in-content searches where the search was most
   1168      likely started from the AI window assistant. The key format is
   1169      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
   1170      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1171    bugs:
   1172      - https://bugzil.la/2001519
   1173    data_reviews:
   1174      - https://bugzil.la/2001519
   1175    notification_emails:
   1176      - fx-search-telemetry@mozilla.com
   1177      - rev-data@mozilla.com
   1178    expires: never
   1179 
   1180  system:
   1181    type: labeled_counter
   1182    description: >
   1183      Records counts for in-content searches where the search was most
   1184      likely started from the system, e.g. command line. The key format is
   1185      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
   1186      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1187      This metric was generated to correspond to the Legacy Telemetry
   1188      scalar browser.search.content.system.
   1189    bugs:
   1190      - https://bugzil.la/1089670
   1191      - https://bugzil.la/1475571
   1192      - https://bugzil.la/1482158
   1193      - https://bugzil.la/1545172
   1194      - https://bugzil.la/1634564
   1195    data_reviews:
   1196      - https://bugzil.la/1089670
   1197      - https://bugzil.la/1475571
   1198      - https://bugzil.la/1482158
   1199      - https://bugzil.la/1545172
   1200      - https://bugzil.la/1634564
   1201    notification_emails:
   1202      - fx-search-telemetry@mozilla.com
   1203      - rev-data@mozilla.com
   1204    expires: never
   1205    telemetry_mirror: BROWSER_SEARCH_CONTENT_SYSTEM
   1206 
   1207  tabhistory:
   1208    type: labeled_counter
   1209    description: >
   1210      Records counts for in-content searches where the search was loaded
   1211      from the tab history. The key format is
   1212      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
   1213      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1214      This metric was generated to correspond to the Legacy Telemetry
   1215      scalar browser.search.content.tabhistory.
   1216    bugs:
   1217      - https://bugzil.la/1634564
   1218    data_reviews:
   1219      - https://bugzil.la/1634564
   1220    notification_emails:
   1221      - fx-search-telemetry@mozilla.com
   1222      - rev-data@mozilla.com
   1223    expires: never
   1224    telemetry_mirror: BROWSER_SEARCH_CONTENT_TABHISTORY
   1225 
   1226  reload:
   1227    type: labeled_counter
   1228    description: >
   1229      Records counts for in-content searches where the search was loaded
   1230      by reloading the page. The key format is
   1231      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
   1232      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1233      This metric was generated to correspond to the Legacy Telemetry
   1234      scalar browser.search.content.reload.
   1235    bugs:
   1236      - https://bugzil.la/1634564
   1237    data_reviews:
   1238      - https://bugzil.la/1634564
   1239    notification_emails:
   1240      - fx-search-telemetry@mozilla.com
   1241      - rev-data@mozilla.com
   1242    expires: never
   1243    telemetry_mirror: BROWSER_SEARCH_CONTENT_RELOAD
   1244 
   1245  unknown:
   1246    type: labeled_counter
   1247    description: >
   1248      Records counts for in-content searches where the search was started
   1249      from a place that could not be determined or not categorized by the
   1250      other scalars. The key format is
   1251      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
   1252      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1253      This metric was generated to correspond to the Legacy Telemetry
   1254      scalar browser.search.content.unknown.
   1255    bugs:
   1256      - https://bugzil.la/1089670
   1257      - https://bugzil.la/1475571
   1258      - https://bugzil.la/1482158
   1259      - https://bugzil.la/1545172
   1260      - https://bugzil.la/1634564
   1261    data_reviews:
   1262      - https://bugzil.la/1089670
   1263      - https://bugzil.la/1475571
   1264      - https://bugzil.la/1482158
   1265      - https://bugzil.la/1545172
   1266      - https://bugzil.la/1634564
   1267    notification_emails:
   1268      - fx-search-telemetry@mozilla.com
   1269      - rev-data@mozilla.com
   1270    expires: never
   1271    telemetry_mirror: BROWSER_SEARCH_CONTENT_UNKNOWN
   1272 
   1273 browser.search.withads:
   1274  urlbar:
   1275    type: labeled_counter
   1276    description: >
   1277      Records counts of SERP pages with adverts displayed where the search
   1278      was started from the urlbar. The key format is
   1279      ‘<provider>:<tagged|organic>’
   1280      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1281      This metric was generated to correspond to the Legacy Telemetry
   1282      scalar browser.search.withads.urlbar.
   1283    bugs:
   1284      - https://bugzil.la/1664847
   1285    data_reviews:
   1286      - https://bugzil.la/1664847
   1287    notification_emails:
   1288      - fx-search-telemetry@mozilla.com
   1289      - rev-data@mozilla.com
   1290    expires: never
   1291    telemetry_mirror: BROWSER_SEARCH_WITHADS_URLBAR
   1292 
   1293  urlbar_handoff:
   1294    type: labeled_counter
   1295    description: >
   1296      The count URI loads triggered in a subsession from the urlbar via
   1297      handoff, broken down by the originating action.
   1298      This metric was generated to correspond to the Legacy Telemetry
   1299      scalar browser.search.withads.urlbar_handoff.
   1300    bugs:
   1301      - https://bugzil.la/1732429
   1302    data_reviews:
   1303      - https://bugzil.la/1732429
   1304    notification_emails:
   1305      - fx-search-telemetry@mozilla.com
   1306      - rev-data@mozilla.com
   1307    expires: never
   1308    telemetry_mirror: BROWSER_SEARCH_WITHADS_URLBAR_HANDOFF
   1309 
   1310  urlbar_persisted:
   1311    type: labeled_counter
   1312    description: >
   1313      Records counts of SERP pages with adverts displayed where the search
   1314      was started from the urlbar after the search term was shown in the
   1315      urlbar. The key format is ‘<provider>:<tagged|organic>’
   1316      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1317      This metric was generated to correspond to the Legacy Telemetry
   1318      scalar browser.search.withads.urlbar_persisted.
   1319    bugs:
   1320      - https://bugzil.la/1779471
   1321    data_reviews:
   1322      - https://bugzil.la/1779471
   1323    notification_emails:
   1324      - fx-search-telemetry@mozilla.com
   1325      - rev-data@mozilla.com
   1326    expires: never
   1327    telemetry_mirror: BROWSER_SEARCH_WITHADS_URLBAR_PERSISTED
   1328 
   1329  urlbar_searchmode:
   1330    type: labeled_counter
   1331    description: >
   1332      Records counts of SERP pages with adverts displayed where the search
   1333      was started from the urlbar in search mode. The key format is
   1334      ‘<provider>:<tagged|organic>’
   1335      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1336      This metric was generated to correspond to the Legacy Telemetry
   1337      scalar browser.search.withads.urlbar_searchmode.
   1338    bugs:
   1339      - https://bugzil.la/1664847
   1340    data_reviews:
   1341      - https://bugzil.la/1664847
   1342    notification_emails:
   1343      - fx-search-telemetry@mozilla.com
   1344      - rev-data@mozilla.com
   1345    expires: never
   1346    telemetry_mirror: BROWSER_SEARCH_WITHADS_URLBAR_SEARCHMODE
   1347 
   1348  searchbar:
   1349    type: labeled_counter
   1350    description: >
   1351      Records counts of SERP pages with adverts displayed where the search
   1352      was started from the search bar. The key format is
   1353      ‘<provider>:<tagged|organic>’
   1354      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1355      This metric was generated to correspond to the Legacy Telemetry
   1356      scalar browser.search.withads.searchbar.
   1357    bugs:
   1358      - https://bugzil.la/1664847
   1359    data_reviews:
   1360      - https://bugzil.la/1664847
   1361    notification_emails:
   1362      - fx-search-telemetry@mozilla.com
   1363      - rev-data@mozilla.com
   1364    expires: never
   1365    telemetry_mirror: BROWSER_SEARCH_WITHADS_SEARCHBAR
   1366 
   1367  about_home:
   1368    type: labeled_counter
   1369    description: >
   1370      Records counts of SERP pages with adverts displayed where the search
   1371      was started from about:home. The key format is
   1372      ‘<provider>:<tagged|organic>’
   1373      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1374      This metric was generated to correspond to the Legacy Telemetry
   1375      scalar browser.search.withads.about_home.
   1376    bugs:
   1377      - https://bugzil.la/1664847
   1378    data_reviews:
   1379      - https://bugzil.la/1664847
   1380    notification_emails:
   1381      - fx-search-telemetry@mozilla.com
   1382      - rev-data@mozilla.com
   1383    expires: never
   1384    telemetry_mirror: BROWSER_SEARCH_WITHADS_ABOUT_HOME
   1385 
   1386  about_newtab:
   1387    type: labeled_counter
   1388    description: >
   1389      Records counts of SERP pages with adverts displayed where the search
   1390      was started from about:newtab. The key format is
   1391      ‘<provider>:<tagged|organic>’
   1392      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1393      This metric was generated to correspond to the Legacy Telemetry
   1394      scalar browser.search.withads.about_newtab.
   1395    bugs:
   1396      - https://bugzil.la/1664847
   1397    data_reviews:
   1398      - https://bugzil.la/1664847
   1399    notification_emails:
   1400      - fx-search-telemetry@mozilla.com
   1401      - rev-data@mozilla.com
   1402    expires: never
   1403    telemetry_mirror: BROWSER_SEARCH_WITHADS_ABOUT_NEWTAB
   1404 
   1405  contextmenu:
   1406    type: labeled_counter
   1407    description: >
   1408      Records counts of SERP pages with adverts displayed where the search
   1409      was started from the context menu. The key format is
   1410      ‘<provider>:<tagged|organic>’
   1411      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1412      This metric was generated to correspond to the Legacy Telemetry
   1413      scalar browser.search.withads.contextmenu.
   1414    bugs:
   1415      - https://bugzil.la/1664847
   1416    data_reviews:
   1417      - https://bugzil.la/1664847
   1418    notification_emails:
   1419      - fx-search-telemetry@mozilla.com
   1420      - rev-data@mozilla.com
   1421    expires: never
   1422    telemetry_mirror: BROWSER_SEARCH_WITHADS_CONTEXTMENU
   1423 
   1424  contextmenu_visual:
   1425    type: labeled_counter
   1426    description: >
   1427      Records counts of visual-search SERP pages with adverts displayed where
   1428      the search was started from the context menu. The key format is the same
   1429      as for the `contextmenu` labeled counter.
   1430    data_sensitivity:
   1431      - interaction
   1432    bugs:
   1433      - https://bugzil.la/1979211
   1434    data_reviews:
   1435      - https://bugzil.la/1979211
   1436    notification_emails:
   1437      - fx-search-telemetry@mozilla.com
   1438      - rev-data@mozilla.com
   1439    expires: never
   1440 
   1441  webextension:
   1442    type: labeled_counter
   1443    description: >
   1444      Records counts of SERP pages with adverts displayed where the search
   1445      was started from a webextension. The key format is
   1446      ‘<provider>:<tagged|organic>’ See https://firefox-source-
   1447      docs.mozilla.org/browser/search/telemetry.html#browser-search-
   1448      content
   1449      This metric was generated to correspond to the Legacy Telemetry
   1450      scalar browser.search.withads.webextension.
   1451    bugs:
   1452      - https://bugzil.la/1664847
   1453    data_reviews:
   1454      - https://bugzil.la/1664847
   1455    notification_emails:
   1456      - fx-search-telemetry@mozilla.com
   1457      - rev-data@mozilla.com
   1458    expires: never
   1459    telemetry_mirror: BROWSER_SEARCH_WITHADS_WEBEXTENSION
   1460 
   1461  aiwindow_assistant:
   1462    type: labeled_counter
   1463    description: >
   1464      Records counts of SERP pages with adverts displayed where the search
   1465      was started from the AI window assistant. The key format is
   1466      ‘<provider>:<tagged|organic>’ See https://firefox-source-
   1467      docs.mozilla.org/browser/search/telemetry.html#browser-search-
   1468      content.
   1469    bugs:
   1470      - https://bugzil.la/2001519
   1471    data_reviews:
   1472      - https://bugzil.la/2001519
   1473    notification_emails:
   1474      - fx-search-telemetry@mozilla.com
   1475      - rev-data@mozilla.com
   1476    expires: never
   1477 
   1478  system:
   1479    type: labeled_counter
   1480    description: >
   1481      Records counts of SERP pages with adverts displayed where the search
   1482      was started from the system, e.g. command line. The key format is
   1483      ‘<provider>:<tagged|organic>’
   1484      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1485      This metric was generated to correspond to the Legacy Telemetry
   1486      scalar browser.search.withads.system.
   1487    bugs:
   1488      - https://bugzil.la/1664847
   1489    data_reviews:
   1490      - https://bugzil.la/1664847
   1491    notification_emails:
   1492      - fx-search-telemetry@mozilla.com
   1493      - rev-data@mozilla.com
   1494    expires: never
   1495    telemetry_mirror: BROWSER_SEARCH_WITHADS_SYSTEM
   1496 
   1497  tabhistory:
   1498    type: labeled_counter
   1499    description: >
   1500      Records counts of SERP pages with adverts displayed where the search
   1501      was loaded from the tab history. The key format is
   1502      ‘<provider>:<tagged|organic>’
   1503      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1504      This metric was generated to correspond to the Legacy Telemetry
   1505      scalar browser.search.withads.tabhistory.
   1506    bugs:
   1507      - https://bugzil.la/1664847
   1508    data_reviews:
   1509      - https://bugzil.la/1664847
   1510    notification_emails:
   1511      - fx-search-telemetry@mozilla.com
   1512      - rev-data@mozilla.com
   1513    expires: never
   1514    telemetry_mirror: BROWSER_SEARCH_WITHADS_TABHISTORY
   1515 
   1516  reload:
   1517    type: labeled_counter
   1518    description: >
   1519      Records counts of SERP pages with adverts displayed where the search
   1520      was loaded by reloading the page. The key format is
   1521      ‘<provider>:<tagged|organic>’
   1522      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1523      This metric was generated to correspond to the Legacy Telemetry
   1524      scalar browser.search.withads.reload.
   1525    bugs:
   1526      - https://bugzil.la/1664847
   1527    data_reviews:
   1528      - https://bugzil.la/1664847
   1529    notification_emails:
   1530      - fx-search-telemetry@mozilla.com
   1531      - rev-data@mozilla.com
   1532    expires: never
   1533    telemetry_mirror: BROWSER_SEARCH_WITHADS_RELOAD
   1534 
   1535  unknown:
   1536    type: labeled_counter
   1537    description: >
   1538      Records counts of SERP pages with adverts displayed where the search
   1539      was started from a place not categorized by the other scalars. The
   1540      key format is ‘<provider>:<tagged|organic>’ See https://firefox-
   1541      source-docs.mozilla.org/browser/search/telemetry.html#browser-
   1542      search-content
   1543      This metric was generated to correspond to the Legacy Telemetry
   1544      scalar browser.search.withads.unknown.
   1545    bugs:
   1546      - https://bugzil.la/1664847
   1547    data_reviews:
   1548      - https://bugzil.la/1664847
   1549    notification_emails:
   1550      - fx-search-telemetry@mozilla.com
   1551      - rev-data@mozilla.com
   1552    expires: never
   1553    telemetry_mirror: BROWSER_SEARCH_WITHADS_UNKNOWN
   1554 
   1555 browser.search.adclicks:
   1556  urlbar:
   1557    type: labeled_counter
   1558    description: >
   1559      Records clicks of adverts on SERP pages where the search was started
   1560      from the urlbar. The key format is ‘<provider>:<tagged|organic>’ See
   1561      https://firefox-source-
   1562      docs.mozilla.org/browser/search/telemetry.html#browser-search-
   1563      content
   1564      This metric was generated to correspond to the Legacy Telemetry
   1565      scalar browser.search.adclicks.urlbar.
   1566    bugs:
   1567      - https://bugzil.la/1664847
   1568    data_reviews:
   1569      - https://bugzil.la/1664847
   1570    notification_emails:
   1571      - fx-search-telemetry@mozilla.com
   1572      - rev-data@mozilla.com
   1573    expires: never
   1574    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_URLBAR
   1575 
   1576  urlbar_handoff:
   1577    type: labeled_counter
   1578    description: >
   1579      The count URI loads triggered in a subsession from the urlbar via
   1580      handoff, broken down by the originating action.
   1581      This metric was generated to correspond to the Legacy Telemetry
   1582      scalar browser.search.adclicks.urlbar_handoff.
   1583    bugs:
   1584      - https://bugzil.la/1732429
   1585    data_reviews:
   1586      - https://bugzil.la/1732429
   1587    notification_emails:
   1588      - fx-search-telemetry@mozilla.com
   1589      - rev-data@mozilla.com
   1590    expires: never
   1591    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_URLBAR_HANDOFF
   1592 
   1593  urlbar_persisted:
   1594    type: labeled_counter
   1595    description: >
   1596      Records clicks of adverts on SERP pages where the search was started
   1597      from the urlbar after the search term was shown in the urlbar. The
   1598      key format is ‘<provider>:<tagged|organic>’
   1599      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1600      This metric was generated to correspond to the Legacy Telemetry
   1601      scalar browser.search.adclicks.urlbar_persisted.
   1602    bugs:
   1603      - https://bugzil.la/1779471
   1604    data_reviews:
   1605      - https://bugzil.la/1779471
   1606    notification_emails:
   1607      - fx-search-telemetry@mozilla.com
   1608      - rev-data@mozilla.com
   1609    expires: never
   1610    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_URLBAR_PERSISTED
   1611 
   1612  urlbar_searchmode:
   1613    type: labeled_counter
   1614    description: >
   1615      Records clicks of adverts on SERP pages where the search was started
   1616      from the urlbar in search mode. The key format is
   1617      ‘<provider>:<tagged|organic>’
   1618      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1619      This metric was generated to correspond to the Legacy Telemetry
   1620      scalar browser.search.adclicks.urlbar_searchmode.
   1621    bugs:
   1622      - https://bugzil.la/1664847
   1623    data_reviews:
   1624      - https://bugzil.la/1664847
   1625    notification_emails:
   1626      - fx-search-telemetry@mozilla.com
   1627      - rev-data@mozilla.com
   1628    expires: never
   1629    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_URLBAR_SEARCHMODE
   1630 
   1631  searchbar:
   1632    type: labeled_counter
   1633    description: >
   1634      Records clicks of adverts on SERP pages where the search was started
   1635      from the search bar. The key format is ‘<provider>:<tagged|organic>’
   1636      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1637      This metric was generated to correspond to the Legacy Telemetry
   1638      scalar browser.search.adclicks.searchbar.
   1639    bugs:
   1640      - https://bugzil.la/1664847
   1641    data_reviews:
   1642      - https://bugzil.la/1664847
   1643    notification_emails:
   1644      - fx-search-telemetry@mozilla.com
   1645      - rev-data@mozilla.com
   1646    expires: never
   1647    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_SEARCHBAR
   1648 
   1649  about_home:
   1650    type: labeled_counter
   1651    description: >
   1652      Records clicks of adverts on SERP pages where the search was started
   1653      from about:home. The key format is ‘<provider>:<tagged|organic>’ See
   1654      https://firefox-source-
   1655      docs.mozilla.org/browser/search/telemetry.html#browser-search-
   1656      content
   1657      This metric was generated to correspond to the Legacy Telemetry
   1658      scalar browser.search.adclicks.about_home.
   1659    bugs:
   1660      - https://bugzil.la/1664847
   1661    data_reviews:
   1662      - https://bugzil.la/1664847
   1663    notification_emails:
   1664      - fx-search-telemetry@mozilla.com
   1665      - rev-data@mozilla.com
   1666    expires: never
   1667    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_ABOUT_HOME
   1668 
   1669  about_newtab:
   1670    type: labeled_counter
   1671    description: >
   1672      Records clicks of adverts on SERP pages where the search was started
   1673      from about:newtab. The key format is ‘<provider>:<tagged|organic>’
   1674      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1675      This metric was generated to correspond to the Legacy Telemetry
   1676      scalar browser.search.adclicks.about_newtab.
   1677    bugs:
   1678      - https://bugzil.la/1664847
   1679    data_reviews:
   1680      - https://bugzil.la/1664847
   1681    notification_emails:
   1682      - fx-search-telemetry@mozilla.com
   1683      - rev-data@mozilla.com
   1684    expires: never
   1685    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_ABOUT_NEWTAB
   1686 
   1687  contextmenu:
   1688    type: labeled_counter
   1689    description: >
   1690      Records clicks of adverts on SERP pages where the search was started
   1691      from the context menu. The key format is
   1692      ‘<provider>:<tagged|organic>’
   1693      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1694      This metric was generated to correspond to the Legacy Telemetry
   1695      scalar browser.search.adclicks.contextmenu.
   1696    bugs:
   1697      - https://bugzil.la/1664847
   1698    data_reviews:
   1699      - https://bugzil.la/1664847
   1700    notification_emails:
   1701      - fx-search-telemetry@mozilla.com
   1702      - rev-data@mozilla.com
   1703    expires: never
   1704    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_CONTEXTMENU
   1705 
   1706  contextmenu_visual:
   1707    type: labeled_counter
   1708    description: >
   1709      Records clicks of adverts on visual-search SERP pages where the search was
   1710      started from the context menu. The key format is the same as for the
   1711      `contextmenu` labeled counter.
   1712    data_sensitivity:
   1713      - interaction
   1714    bugs:
   1715      - https://bugzil.la/1979211
   1716    data_reviews:
   1717      - https://bugzil.la/1979211
   1718    notification_emails:
   1719      - fx-search-telemetry@mozilla.com
   1720      - rev-data@mozilla.com
   1721    expires: never
   1722 
   1723  webextension:
   1724    type: labeled_counter
   1725    description: >
   1726      Records clicks of adverts on SERP pages where the search was started
   1727      from a webextension. The key format is ‘<provider>:<tagged|organic>’
   1728      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1729      This metric was generated to correspond to the Legacy Telemetry
   1730      scalar browser.search.adclicks.webextension.
   1731    bugs:
   1732      - https://bugzil.la/1664847
   1733    data_reviews:
   1734      - https://bugzil.la/1664847
   1735    notification_emails:
   1736      - fx-search-telemetry@mozilla.com
   1737      - rev-data@mozilla.com
   1738    expires: never
   1739    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_WEBEXTENSION
   1740 
   1741  aiwindow_assistant:
   1742    type: labeled_counter
   1743    description: >
   1744      Records clicks of adverts on SERP pages where the search was started
   1745      from the AI window assistant. The key format is ‘<provider>:<tagged|organic>’
   1746      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1747    bugs:
   1748      - https://bugzil.la/2001519
   1749    data_reviews:
   1750      - https://bugzil.la/2001519
   1751    notification_emails:
   1752      - fx-search-telemetry@mozilla.com
   1753      - rev-data@mozilla.com
   1754    expires: never
   1755 
   1756  system:
   1757    type: labeled_counter
   1758    description: >
   1759      Records clicks of adverts on SERP pages where the search was started
   1760      from the system, e.g. command line. The key format is
   1761      ‘<provider>:<tagged|organic>’
   1762      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1763      This metric was generated to correspond to the Legacy Telemetry
   1764      scalar browser.search.adclicks.system.
   1765    bugs:
   1766      - https://bugzil.la/1664847
   1767    data_reviews:
   1768      - https://bugzil.la/1664847
   1769    notification_emails:
   1770      - fx-search-telemetry@mozilla.com
   1771      - rev-data@mozilla.com
   1772    expires: never
   1773    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_SYSTEM
   1774 
   1775  tabhistory:
   1776    type: labeled_counter
   1777    description: >
   1778      Records clicks of adverts on SERP pages where the search was loaded
   1779      from the tab history. The key format is
   1780      ‘<provider>:<tagged|organic>’
   1781      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1782      This metric was generated to correspond to the Legacy Telemetry
   1783      scalar browser.search.adclicks.tabhistory.
   1784    bugs:
   1785      - https://bugzil.la/1664847
   1786    data_reviews:
   1787      - https://bugzil.la/1664847
   1788    notification_emails:
   1789      - fx-search-telemetry@mozilla.com
   1790      - rev-data@mozilla.com
   1791    expires: never
   1792    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_TABHISTORY
   1793 
   1794  reload:
   1795    type: labeled_counter
   1796    description: >
   1797      Records clicks of adverts on SERP pages where the search was loaded
   1798      by reloading the page. The key format is
   1799      ‘<provider>:<tagged|organic>’
   1800      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1801      This metric was generated to correspond to the Legacy Telemetry
   1802      scalar browser.search.adclicks.reload.
   1803    bugs:
   1804      - https://bugzil.la/1664847
   1805    data_reviews:
   1806      - https://bugzil.la/1664847
   1807    notification_emails:
   1808      - fx-search-telemetry@mozilla.com
   1809      - rev-data@mozilla.com
   1810    expires: never
   1811    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_RELOAD
   1812 
   1813  unknown:
   1814    type: labeled_counter
   1815    description: >
   1816      Records clicks of adverts on SERP pages where the search was started
   1817      from a place not categorized by the other scalars. The key format is
   1818      ‘<provider>:<tagged|organic>’
   1819      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
   1820      This metric was generated to correspond to the Legacy Telemetry
   1821      scalar browser.search.adclicks.unknown.
   1822    bugs:
   1823      - https://bugzil.la/1664847
   1824    data_reviews:
   1825      - https://bugzil.la/1664847
   1826    notification_emails:
   1827      - fx-search-telemetry@mozilla.com
   1828      - rev-data@mozilla.com
   1829    expires: never
   1830    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_UNKNOWN
   1831 
   1832 urlbar.searchmode:
   1833  bookmarkmenu:
   1834    type: labeled_counter
   1835    description: >
   1836      A keyed uint recording how many times the user entered a particular
   1837      search mode after selecing the Search Bookmarks menu item in the
   1838      Library menu.
   1839      This metric was generated to correspond to the Legacy Telemetry
   1840      scalar urlbar.searchmode.bookmarkmenu.
   1841    bugs:
   1842      - https://bugzil.la/1665076
   1843    data_reviews:
   1844      - https://bugzil.la/1665076
   1845    notification_emails:
   1846      - fx-search-telemetry@mozilla.com
   1847    expires: never
   1848    telemetry_mirror: URLBAR_SEARCHMODE_BOOKMARKMENU
   1849 
   1850  handoff:
   1851    type: labeled_counter
   1852    description: >
   1853      A keyed uint recording how many times the user entered a particular
   1854      search mode after being handed off from the search bar on the new
   1855      tab page.
   1856      This metric was generated to correspond to the Legacy Telemetry
   1857      scalar urlbar.searchmode.handoff.
   1858    bugs:
   1859      - https://bugzil.la/1654680
   1860      - https://bugzil.la/1665076
   1861    data_reviews:
   1862      - https://bugzil.la/1654680
   1863      - https://bugzil.la/1665076
   1864    notification_emails:
   1865      - fx-search-telemetry@mozilla.com
   1866    expires: never
   1867    telemetry_mirror: URLBAR_SEARCHMODE_HANDOFF
   1868 
   1869  keywordoffer:
   1870    type: labeled_counter
   1871    description: >
   1872      A keyed uint recording how many times the user entered a particular
   1873      search mode after selecting a keyword offer result. The scalar key
   1874      for local search modes entered using a restrict keyword will be
   1875      suffixed with "keyword". For example: tabs_keyword,
   1876      bookmarks_keyword, history_keyword, and actions_keyword.
   1877      This metric was generated to correspond to the Legacy Telemetry
   1878      scalar urlbar.searchmode.keywordoffer.
   1879    bugs:
   1880      - https://bugzil.la/1654680
   1881      - https://bugzil.la/1919180
   1882    data_reviews:
   1883      - https://bugzil.la/1654680
   1884      - https://bugzil.la/1919180
   1885    notification_emails:
   1886      - fx-search-telemetry@mozilla.com
   1887    expires: never
   1888    telemetry_mirror: URLBAR_SEARCHMODE_KEYWORDOFFER
   1889 
   1890  oneoff:
   1891    type: labeled_counter
   1892    description: >
   1893      A keyed uint recording how many times the user entered a particular
   1894      search mode after selecting a one-off.
   1895      This metric was generated to correspond to the Legacy Telemetry
   1896      scalar urlbar.searchmode.oneoff.
   1897    bugs:
   1898      - https://bugzil.la/1654680
   1899    data_reviews:
   1900      - https://bugzil.la/1654680
   1901    notification_emails:
   1902      - fx-search-telemetry@mozilla.com
   1903    expires: never
   1904    telemetry_mirror: URLBAR_SEARCHMODE_ONEOFF
   1905 
   1906  searchbutton:
   1907    type: labeled_counter
   1908    description: >
   1909      A keyed uint recording how many times the user entered a particular
   1910      search mode by unified search button.
   1911      This metric was generated to correspond to the Legacy Telemetry
   1912      scalar urlbar.searchmode.searchbutton.
   1913    bugs:
   1914      - https://bugzil.la/1919857
   1915    data_reviews:
   1916      - https://bugzil.la/1919857
   1917    notification_emails:
   1918      - fx-search-telemetry@mozilla.com
   1919    expires: never
   1920    telemetry_mirror: URLBAR_SEARCHMODE_SEARCHBUTTON
   1921 
   1922  shortcut:
   1923    type: labeled_counter
   1924    description: >
   1925      A keyed uint recording how many times the user entered a particular
   1926      search mode after pressing a keyboard shortcut.
   1927      This metric was generated to correspond to the Legacy Telemetry
   1928      scalar urlbar.searchmode.shortcut.
   1929    bugs:
   1930      - https://bugzil.la/1654680
   1931    data_reviews:
   1932      - https://bugzil.la/1654680
   1933    notification_emails:
   1934      - fx-search-telemetry@mozilla.com
   1935    expires: never
   1936    telemetry_mirror: URLBAR_SEARCHMODE_SHORTCUT
   1937 
   1938  tabmenu:
   1939    type: labeled_counter
   1940    description: >
   1941      A keyed uint recording how many times the user entered a particular
   1942      search mode after selecting the Search Tabs menu item in the Tab
   1943      Overflow menu.
   1944      This metric was generated to correspond to the Legacy Telemetry
   1945      scalar urlbar.searchmode.tabmenu.
   1946    bugs:
   1947      - https://bugzil.la/1665076
   1948    data_reviews:
   1949      - https://bugzil.la/1665076
   1950    notification_emails:
   1951      - fx-search-telemetry@mozilla.com
   1952    expires: never
   1953    telemetry_mirror: URLBAR_SEARCHMODE_TABMENU
   1954 
   1955  tabtosearch:
   1956    type: labeled_counter
   1957    description: >
   1958      A keyed uint recording how many times the user entered a particular
   1959      search mode after selecting a tab-to-search result.
   1960      This metric was generated to correspond to the Legacy Telemetry
   1961      scalar urlbar.searchmode.tabtosearch.
   1962    bugs:
   1963      - https://bugzil.la/1647923
   1964    data_reviews:
   1965      - https://bugzil.la/1647923
   1966    notification_emails:
   1967      - fx-search-telemetry@mozilla.com
   1968    expires: never
   1969    telemetry_mirror: URLBAR_SEARCHMODE_TABTOSEARCH
   1970 
   1971  tabtosearch_onboard:
   1972    type: labeled_counter
   1973    description: >
   1974      A keyed uint recording how many times the user entered a particular
   1975      search mode after selecting a tab-to-search onboarding result.
   1976      This metric was generated to correspond to the Legacy Telemetry
   1977      scalar urlbar.searchmode.tabtosearch_onboard.
   1978    bugs:
   1979      - https://bugzil.la/1665934
   1980    data_reviews:
   1981      - https://bugzil.la/1665934
   1982    notification_emails:
   1983      - fx-search-telemetry@mozilla.com
   1984    expires: never
   1985    telemetry_mirror: URLBAR_SEARCHMODE_TABTOSEARCH_ONBOARD
   1986 
   1987  topsites_newtab:
   1988    type: labeled_counter
   1989    description: >
   1990      A keyed uint recording how many times the user entered a particular
   1991      search mode after selecting a search shortcut Top Site on the New
   1992      Tab Page.
   1993      This metric was generated to correspond to the Legacy Telemetry
   1994      scalar urlbar.searchmode.topsites_newtab.
   1995    bugs:
   1996      - https://bugzil.la/1654680
   1997    data_reviews:
   1998      - https://bugzil.la/1654680
   1999    notification_emails:
   2000      - fx-search-telemetry@mozilla.com
   2001    expires: never
   2002    telemetry_mirror: URLBAR_SEARCHMODE_TOPSITES_NEWTAB
   2003 
   2004  topsites_urlbar:
   2005    type: labeled_counter
   2006    description: >
   2007      A keyed uint recording how many times the user entered a particular
   2008      search mode after selecting a search shortcut Top Site in the
   2009      Urlbar.
   2010      This metric was generated to correspond to the Legacy Telemetry
   2011      scalar urlbar.searchmode.topsites_urlbar.
   2012    bugs:
   2013      - https://bugzil.la/1654680
   2014    data_reviews:
   2015      - https://bugzil.la/1654680
   2016    notification_emails:
   2017      - fx-search-telemetry@mozilla.com
   2018    expires: never
   2019    telemetry_mirror: URLBAR_SEARCHMODE_TOPSITES_URLBAR
   2020 
   2021  touchbar:
   2022    type: labeled_counter
   2023    description: >
   2024      A keyed uint recording how many times the user entered a particular
   2025      search mode after selecting a search shortcut on the macOS Touch
   2026      Bar.
   2027      This metric was generated to correspond to the Legacy Telemetry
   2028      scalar urlbar.searchmode.touchbar.
   2029    bugs:
   2030      - https://bugzil.la/1657414
   2031    data_reviews:
   2032      - https://bugzil.la/1657414
   2033    notification_emails:
   2034      - fx-search-telemetry@mozilla.com
   2035    expires: never
   2036    telemetry_mirror: URLBAR_SEARCHMODE_TOUCHBAR
   2037 
   2038  typed:
   2039    type: labeled_counter
   2040    description: >
   2041      A keyed uint recording how many times the user entered a particular
   2042      search mode after typing an alias. The scalar keys for local search
   2043      modes entered by typing a restrict keyword will be suffixed with
   2044      "keyword". For example: tabs_keyword, bookmarks_keyword,
   2045      history_keyword, and actions_keyword. If instead search mode was
   2046      entered by typing a restrict symbol the key will be suffixed with
   2047      "symbol" (e.g. typing "%" will generate "tabs_symbol").
   2048      This metric was generated to correspond to the Legacy Telemetry
   2049      scalar urlbar.searchmode.typed.
   2050    bugs:
   2051      - https://bugzil.la/1654680
   2052      - https://bugzil.la/1919180
   2053    data_reviews:
   2054      - https://bugzil.la/1654680
   2055      - https://bugzil.la/1919180
   2056    notification_emails:
   2057      - fx-search-telemetry@mozilla.com
   2058    expires: never
   2059    telemetry_mirror: URLBAR_SEARCHMODE_TYPED
   2060 
   2061  historymenu:
   2062    type: labeled_counter
   2063    description: >
   2064      A keyed uint recording how many times the user entered a particular
   2065      search mode after selecing the Search History menu item in a History
   2066      menu.
   2067      This metric was generated to correspond to the Legacy Telemetry
   2068      scalar urlbar.searchmode.historymenu.
   2069    bugs:
   2070      - https://bugzil.la/1736939
   2071    data_reviews:
   2072      - https://bugzil.la/1736939
   2073    notification_emails:
   2074      - fx-search-telemetry@mozilla.com
   2075    expires: never
   2076    telemetry_mirror: URLBAR_SEARCHMODE_HISTORYMENU
   2077 
   2078  other:
   2079    type: labeled_counter
   2080    description: >
   2081      A keyed uint recording how many times the user entered a particular
   2082      search mode from an unknown entry point. If values appear for this
   2083      probe in Telemetry, we should review the entry points to search
   2084      mode.
   2085      This metric was generated to correspond to the Legacy Telemetry
   2086      scalar urlbar.searchmode.other.
   2087    bugs:
   2088      - https://bugzil.la/1654680
   2089    data_reviews:
   2090      - https://bugzil.la/1654680
   2091    notification_emails:
   2092      - fx-search-telemetry@mozilla.com
   2093    expires: never
   2094    telemetry_mirror: URLBAR_SEARCHMODE_OTHER
   2095 
   2096 searchbar:
   2097  selected_result_method:
   2098    type: labeled_counter
   2099    description: >
   2100      The input method the user used to select a result in the searchbar.
   2101      'enter' => The user hit the Enter key without choosing a result in the
   2102      popup. 'enterSelection' => The user chose a result and then hit the Enter
   2103      key. 'click' => The user clicked a result with the mouse.
   2104 
   2105      This metric was generated to correspond to the Legacy Telemetry
   2106      categorical histogram FX_SEARCHBAR_SELECTED_RESULT_METHOD.
   2107    labels:
   2108      - enter
   2109      - enterSelection
   2110      - click
   2111    bugs:
   2112      - https://bugzilla.mozilla.org/show_bug.cgi?id=1334615
   2113    data_reviews:
   2114      - https://bugzilla.mozilla.org/show_bug.cgi?id=1334615
   2115    notification_emails:
   2116      - fx-search-telemetry@mozilla.com
   2117    expires: never
   2118    telemetry_mirror: h#FX_SEARCHBAR_SELECTED_RESULT_METHOD