# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - 'Firefox :: Search'

newtab.search:
  issued:
    type: event
    description: >
      When Firefox was asked to issue a search from a Search Access Point (SAP)
      on a newtab page.
      Doesn't record searches in Private Browsing Mode unless
      `browser.engagement.search_counts.pbm` is set to `true`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      newtab_visit_id: &newtab_visit_id
        description: >
          The id of the newtab visit that originated the search.
          Should always be present for handoff searches.
          TODO(bug 1774597): for searches done without handoff (e.g. with
          `browser.newtabpage.activity-stream.improvesearch.handoffToAwesomebar`
          set to `false`), the active newtab visit id is unknown.
        type: string
      search_access_point: &search_access_point
        description: >
          One of the search access points available on the new tab like
          * `urlbar_handoff`
          * `about_home`
          * `about_newtab`
        type: string
      telemetry_id: &telemetry_id
        description: >
          The search engine's `telemetryId`, like `google-b-d`.
          This is set to be a telemetry-specific id for app-provided engines,
          and is `other-<name>` for others (where `<name>` is the engine's
          WebExtension name).
        type: string
    send_in_pings:
      - newtab

newtab.search.ad:
  impression:
    type: event
    description: >
      Recorded when a newtab visit resulted in a search that
      loaded a Search Engine Result Page (SERP) that contains an ad link.
      And the SERP is visible.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      newtab_visit_id: *newtab_visit_id
      search_access_point: *search_access_point
      is_follow_on: &is_follow_on
        description: >
          Whether the preceding search happened on a search results page.
        type: boolean
      is_tagged: &is_tagged
        description: >
          Whether the preceding search was tagged with a partner code.
        type: boolean
      telemetry_id: *telemetry_id
    send_in_pings:
      - newtab

  click:
    type: event
    description: >
      Recorded when an ad link is clicked on a Search Engine Result Page (SERP)
      which was loaded by a seach that began on a newtab page.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    data_sensitivity:
      - interaction
    notification_emails:
      - anicholson@mozilla.com
      - chutten@mozilla.com
      - mmccorquodale@mozilla.com
      - najiang@mozilla.com
      - lina@mozilla.com
    expires: never
    extra_keys:
      newtab_visit_id: *newtab_visit_id
      search_access_point: *search_access_point
      is_follow_on: *is_follow_on
      is_tagged: *is_tagged
      telemetry_id: *telemetry_id
    send_in_pings:
      - newtab

sap:
  counts:
    type: event
    description: >
      Recorded search counts when a user initiates a search from a search access
      point (SAP). It does not guarantee that the search engine result page was
      loaded successfully (use SERP telemetry).
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1938929
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1938929
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    extra_keys:
      source:
        description: >
          The search access point from which the user initiated the search.
          Possible values are:
          `abouthome`, `contextmenu`, `newtab`, `searchbar`, `system`, `urlbar`,
          `urlbar-handoff`, `urlbar-persisted`, `urlbar-searchmode`, `webextension`
        type: string
      provider_id:
        description: >
          The identifier of the search engine provider that is being used for the
          search. Note this may be different to the identifier of the provider in
          SERP reports. For user installed engines, this will be the string `other`.
        type: string
      provider_name:
        description: >
          The name of the search engine provider that is being used for the search.
        type: string
      partner_code:
        description: >
          The partner code, if defined/known, that is being used for the search.
          Not all search engines have partner codes. May be empty for engines that
          are overridden by a third-party add-on or OpenSearch engine.
        type: string
      overridden_by_third_party:
        description: >
          Set to true if the search engine has been allowed to be overridden by
          a third-party add-on or OpenSearch engine.
        type: boolean

  deprecated_counts:
    type: labeled_counter
    description: >
      This is deprecated metric that should not be incoporated into dashboards.
      Use the `sap.counts` event instead.

      This metric has been added to Glean to aid transition of
      histograms and allow the legacy telemetry SEARCH_COUNTS to continue to be
      recorded.

      Records search counts for search access points. The format is:
      <engine-name>.<search-access-point>. For the urlbar when in search mode,
      the format is <engine name>.urlbar-searchmode. For the urlbar when an
      internal @engine shortcut is used, the format is: <engine-name>.alias.

      This metric was generated to correspond to the Legacy Telemetry count
      histogram SEARCH_COUNTS.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1089670
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1475571
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1482158
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1499193
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1545172
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1572500
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1654680
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1089670
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1475571
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1482158
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1499193
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1545172
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1572500
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1654680
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: h#SEARCH_COUNTS

  search_form_counts:
    type: event
    description: >
      Records how often users visit the homepages of search engines (also
      known as SearchForm) using a SAP. It only counts how many visits were
      initiated, not how many homepages were loaded successfully.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1915252
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1915252
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    extra_keys:
      source:
        description: >
          The search access point from which the user initiated the search.
          Possible values are `searchbar` and `urlbar`.
        type: string
      provider_id:
        description: >
          The identifier of the search engine provider that is being used for the
          search. Note this may be different to the identifier of the provider in
          SERP reports. For user installed engines, this will be the string `other`.
        type: string

serp:
  impression:
    type: event
    description: >
      Recorded when a search engine results page (SERP) is shown to a user.
      The feature began rolling out to all users with Firefox 115, and was
      permanently enabled in Firefox 119.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1813162
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1824543
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816736
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816738
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1829953
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1851495
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1813162
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1824543
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1851495
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    extra_keys:
      impression_id: &impression_id
        description: >
          A uuid to link SERP events to user's engagement events.
        type: string
      provider:
        description: >
          The name of the provider.
        type: string
      tagged:
        description: >
          Whether the search is tagged (true) or organic (false).
        type: boolean
      partner_code:
        description: >
          Any partner_code parsing in the URL or an empty string if not
          available.
        type: string
      source:
        description: >
          How the user arrived at the SERP.
          Possible values are:
          `urlbar`, `urlbar_handoff`, `urlbar_searchmode`, `urlbar_persisted`,
          `searchbar`, `contextmenu`, `webextension`, `system`, `reload`,
          `tabhistory`, `follow_on_from_refine_on_incontent_search`,
          `follow_on_from_refine_on_SERP`, `opened_in_new_tab`, `unknown`.
          This will be `unknown` if we cannot determine the source.
        type: string
      shopping_tab_displayed:
        description:
          Indicates if the shopping tab is displayed.
        type: boolean
      is_shopping_page:
        description:
          Indicates if the page is a shopping page.
        type: boolean
      is_private:
        description:
          Indicates if the page was loaded while in Private Browsing Mode.
          Added in Firefox 120.
        type: boolean
      is_signed_in:
        description:
          Indicates if the page was loaded while the user is signed in to a
          provider's account. Added in Firefox 127.
        type: boolean

  engagement:
    type: event
    description: >
      Recorded user actions on a SERP.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1814773
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816730
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816735
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849371
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1901839
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1814773
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816730
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849371
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    extra_keys:
      impression_id: *impression_id
      action:
        description: >
          The action taken on the page.
          Possible values are:
          `clicked`,
          `clicked_accept`,
          `clicked_reject`,
          `clicked_more_options`,
          `expanded`,
          `submitted`.
        type: string
      target:
        description: >
          The target component used to trigger the action.
          Possible values are:
          `ad_carousel`,
          `ad_image_row`,
          `ad_link`,
          `ad_popover`,
          `ad_sidebar`,
          `ad_sitelink`,
          `ad_uncategorized` (added in Firefox 129),
          `cookie_banner`,
          `incontent_searchbox`,
          `non_ads_link`,
          `refined_search_buttons`,
          `shopping_tab`.
          `ad_uncategorized` are likely the result of an engagement with an ad
          loaded after the page was categorized for components (e.g. infinite
          scrolling).
        type: string

  ad_impression:
    type: event
    description: >
      Recorded when a user loads a SERP and ads are detected.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816728
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816729
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849371
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1909979
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1816728
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1849371
      - https://phabricator.services.mozilla.com/D217999
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    extra_keys:
      impression_id: *impression_id
      component:
        description: >
          Type of components on a SERP. Possible values are:
          `ad_carousel`,
          `ad_image_row`,
          `ad_link`,
          `ad_popover`,
          `ad_sidebar`,
          `ad_sitelink`,
          `cookie_banner`,
          `refined_search_buttons`,
          `shopping_tab`.
          Defaults to `ad_link`. `ad_popover` was added as a temporary component
          in August 2024 as a response to clients reporting an extra hidden ad
          and stopped being reported in telemetry with Firefox 131 as the
          version added the ability to categorize links but not report them in
          telemetry.
        type: string
      ads_loaded:
        description: >
          Number of ads loaded for this component. They may or
          may not be visible on the page.
        type: quantity
      ads_visible:
        description: >
          Number of ads visible for this component. An ad can be
          considered visible if was within the browser window
          by the time the impression was recorded.
        type: quantity
      ads_hidden:
        description: >
          Number of ads hidden for this component. These are ads that
          are loaded in the DOM but hidden via CSS and/or Javascript.
        type: quantity

  abandonment:
    type: event
    description: >
      Recorded when there is no engagement with the SERP before the tab is
      closed, the window is closed, the app is closed, or the tab is navigated
      away from.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1814776
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1814776
    data_sensitivity:
      - interaction
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    extra_keys:
      impression_id: *impression_id
      reason:
        description: >
          Why the SERP is deemed abandoned.
          Possible values are:
          `tab_close`, `window_close`, `navigation`
        type: string

  categorization_duration:
    type: timing_distribution
    time_unit: millisecond
    description: >
      The time it takes to categorize elements on a SERP.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1834100
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1834100
    data_sensitivity:
      - technical
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  categorization:
    type: event
    description: >
      A high-level categorization of a SERP (a best guess as to its topic),
      using buckets such as "sports" or "travel".
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1868476
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1869064
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1887686
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1892267
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1868476
    data_sensitivity:
      - stored_content
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    extra_keys:
      sponsored_category:
        description: >
          An index corresponding to a broad category for the SERP, derived from
          sponsored domains.
        type: quantity
      sponsored_num_domains:
        description: >
          The total number of sponsored domains used in the categorization
          process for the SERP.
        type: quantity
      sponsored_num_unknown:
        description: >
          The count of sponsored domains extracted from the SERP that are not
          found in the domain-to-categories mapping.
        type: quantity
      sponsored_num_inconclusive:
        description: >
          The count of sponsored domains extracted from the SERP that are found
          in the domain-to-categories mapping but are deemed inconclusive.
        type: quantity
      organic_category:
        description: >
          An index corresponding to a broad category for the SERP, derived from
          organic domains.
        type: quantity
      organic_num_domains:
        description: >
          The total number of organic domains used in the categorization
          process for the SERP.
        type: quantity
      organic_num_unknown:
        description: >
          The count of organic domains extracted from the SERP that are not
          found in the domain-to-categories mapping.
        type: quantity
      organic_num_inconclusive:
        description: >
          The count of organic domains extracted from the SERP that are found
          in the domain-to-categories mapping but are deemed inconclusive.
        type: quantity
      region:
        description: >
          A two-letter country code indicating where the SERP was loaded.
        type: string
      channel:
        description: >
          The type of update channel, for example: “nightly”, “beta”, “release”.
        type: string
      provider:
        description: >
          The name of the provider.
        type: string
      tagged:
        description: >
          Whether the search is tagged (true) or organic (false).
        type: boolean
      partner_code:
        description: >
          Any partner_code parsing in the URL or an empty string if not
          available.
        type: string
      app_version:
        description: >
          The Firefox major version used, for example: 126.
        type: quantity
      mappings_version:
        description: >
          Version number for the Remote Settings attachments used to generate
          the domain-to-categories map used in the SERP categorization process.
        type: quantity
      is_shopping_page:
        description: >
          Indicates if the page is a shopping page.
        type: boolean
      num_ads_hidden:
        description: >
          Number of ads hidden on the page at the time of categorizing the
          page.
        type: quantity
      num_ads_loaded:
        description: >
          Number of ads loaded on the page at the time of categorizing the
          page.
        type: quantity
      num_ads_visible:
        description: >
          Number of ads visible on the page at the time of categorizing the
          page.
        type: quantity
      num_ads_clicked:
        description: >
          Number of ads clicked on the page.
        type: quantity
    send_in_pings:
      - serp-categorization

  ads_blocked_count:
    type: labeled_counter
    description: >
      Counts the specific type of block.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1907097
    data_reviews:
      - https://phabricator.services.mozilla.com/D216208
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    data_sensitivity:
      - technical
    labels:
      - beyond_viewport
      - hidden_parent
      - hidden_child

  experiment_info:
    type: object
    description: >
      Whether the client is enrolled in a specified experiment and if so, which
      branch the client is assigned to. The target experiment is specified in
      the Nimbus config by creating a "targetExperiment" key and setting its
      value to the experiment's slug (and ensuring the featureId is "search").
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1879667
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1868476
    data_sensitivity:
      - technical
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    structure:
      type: object
      properties:
        slug:
          type: string
        branch:
          type: string
    send_in_pings:
      - serp-categorization

  categorization_no_map_found:
    type: counter
    description: >
      A count incremented upon a SERP categorization event being recorded
      without a corresponding impression event being recorded. This metric
      effectively counts missing impressions due to issues with the
      domain-to-categories map.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1900094
    data_reviews:
      - https://phabricator.services.mozilla.com/D214868
    data_sensitivity:
      - technical
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    send_in_pings:
      - serp-categorization

search_with:
  reporting_url:
    type: url
    description: >
      The external url to report this interaction to.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1870138
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1870138
    data_sensitivity:
      - web_activity
    notification_emails:
      - mkaply@mozilla.com
    expires: never
    send_in_pings:
      - search-with

  context_id:
    type: uuid
    description: >
      An identifier for Contextual Services user interaction pings. This is
      used internally for counting unique users as well as for anti-fraud. It
      is shared with other Contextual Services. It is not shared externally.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1870138
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1870138#c3
    data_sensitivity:
      - technical
    notification_emails:
      - mkaply@mozilla.com
    expires: never
    send_in_pings:
      - search-with

browser.engagement.navigation:
  urlbar:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from the urlbar,
      broken down by the originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.navigation.urlbar.
    bugs:
      - https://bugzil.la/1271313
    data_reviews:
      - https://bugzil.la/1271313
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_URLBAR

  urlbar_handoff:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from the urlbar via
      handoff, broken down by the originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.navigation.urlbar_handoff.
    bugs:
      - https://bugzil.la/1732429
    data_reviews:
      - https://bugzil.la/1732429
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_URLBAR_HANDOFF

  urlbar_persisted:
    type: labeled_counter
    description: >
      The count of URI loads triggered in a subsession from the urlbar
      after the search term was shown in the urlbar, broken down by the
      originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.navigation.urlbar_persisted.
    bugs:
      - https://bugzil.la/1779471
    data_reviews:
      - https://bugzil.la/1779471
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_URLBAR_PERSISTED

  urlbar_searchmode:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from the urlbar's
      search mode, broken down by the originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.navigation.urlbar_searchmode.
    bugs:
      - https://bugzil.la/1654680
    data_reviews:
      - https://bugzil.la/1654680
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_URLBAR_SEARCHMODE

  searchbar:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from the searchbar,
      broken down by the originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.navigation.searchbar.
    bugs:
      - https://bugzil.la/1271313
    data_reviews:
      - https://bugzil.la/1271313
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_SEARCHBAR

  about_home:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from about:home,
      broken down by the originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.navigation.about_home.
    bugs:
      - https://bugzil.la/1271313
    data_reviews:
      - https://bugzil.la/1271313
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_ABOUT_HOME

  about_newtab:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from about:newtab,
      broken down by the originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.navigation.about_newtab.
    bugs:
      - https://bugzil.la/1271313
    data_reviews:
      - https://bugzil.la/1271313
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_ABOUT_NEWTAB

  contextmenu:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from the contextmenu,
      broken down by the originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.navigation.contextmenu.
    bugs:
      - https://bugzil.la/1271313
    data_reviews:
      - https://bugzil.la/1271313
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_CONTEXTMENU

  webextension:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from a webextension.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.engagement.navigation.webextension.
    bugs:
      - https://bugzil.la/1492233
    data_reviews:
      - https://bugzil.la/1492233
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_ENGAGEMENT_NAVIGATION_WEBEXTENSION

browser.search.content:
  urlbar:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was most
      likely started from the urlbar. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.urlbar.
    bugs:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_URLBAR

  urlbar_handoff:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from the urlbar via
      handoff, broken down by the originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.urlbar_handoff.
    bugs:
      - https://bugzil.la/1732429
    data_reviews:
      - https://bugzil.la/1732429
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_URLBAR_HANDOFF

  urlbar_persisted:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was most
      likely started from the urlbar after the search term was shown in
      the urlbar. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.urlbar_persisted.
    bugs:
      - https://bugzil.la/1779471
    data_reviews:
      - https://bugzil.la/1779471
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_URLBAR_PERSISTED

  urlbar_searchmode:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was most
      likely started from the urlbar in search mode. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.urlbar_searchmode.
    bugs:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_URLBAR_SEARCHMODE

  searchbar:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was most
      likely started from the search bar. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.searchbar.
    bugs:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_SEARCHBAR

  about_home:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was most
      likely started from the about:home. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.about_home.
    bugs:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_ABOUT_HOME

  about_newtab:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was most
      likely started from the about:newtab. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.about_newtab.
    bugs:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_ABOUT_NEWTAB

  contextmenu:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was most
      likely started from the context menu. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.contextmenu.
    bugs:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_CONTEXTMENU

  webextension:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was most
      likely started from a webextension. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.webextension.
    bugs:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_WEBEXTENSION

  system:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was most
      likely started from the system, e.g. command line. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.system.
    bugs:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_SYSTEM

  tabhistory:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was loaded
      from the tab history. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.tabhistory.
    bugs:
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_TABHISTORY

  reload:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was loaded
      by reloading the page. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.reload.
    bugs:
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_RELOAD

  unknown:
    type: labeled_counter
    description: >
      Records counts for in-content searches where the search was started
      from a place that could not be determined or not categorized by the
      other scalars. The key format is
      <provider>:[tagged|tagged-follow-on|organic]:[code|other|none]
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.content.unknown.
    bugs:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    data_reviews:
      - https://bugzil.la/1089670
      - https://bugzil.la/1475571
      - https://bugzil.la/1482158
      - https://bugzil.la/1545172
      - https://bugzil.la/1634564
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_CONTENT_UNKNOWN

browser.search.withads:
  urlbar:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was started from the urlbar. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.urlbar.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_URLBAR

  urlbar_handoff:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from the urlbar via
      handoff, broken down by the originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.urlbar_handoff.
    bugs:
      - https://bugzil.la/1732429
    data_reviews:
      - https://bugzil.la/1732429
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_URLBAR_HANDOFF

  urlbar_persisted:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was started from the urlbar after the search term was shown in the
      urlbar. The key format is ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.urlbar_persisted.
    bugs:
      - https://bugzil.la/1779471
    data_reviews:
      - https://bugzil.la/1779471
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_URLBAR_PERSISTED

  urlbar_searchmode:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was started from the urlbar in search mode. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.urlbar_searchmode.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_URLBAR_SEARCHMODE

  searchbar:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was started from the search bar. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.searchbar.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_SEARCHBAR

  about_home:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was started from about:home. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.about_home.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_ABOUT_HOME

  about_newtab:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was started from about:newtab. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.about_newtab.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_ABOUT_NEWTAB

  contextmenu:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was started from the context menu. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.contextmenu.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_CONTEXTMENU

  webextension:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was started from a webextension. The key format is
      ‘<provider>:<tagged|organic>’ See https://firefox-source-
      docs.mozilla.org/browser/search/telemetry.html#browser-search-
      content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.webextension.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_WEBEXTENSION

  system:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was started from the system, e.g. command line. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.system.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_SYSTEM

  tabhistory:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was loaded from the tab history. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.tabhistory.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_TABHISTORY

  reload:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was loaded by reloading the page. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.reload.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_RELOAD

  unknown:
    type: labeled_counter
    description: >
      Records counts of SERP pages with adverts displayed where the search
      was started from a place not categorized by the other scalars. The
      key format is ‘<provider>:<tagged|organic>’ See https://firefox-
      source-docs.mozilla.org/browser/search/telemetry.html#browser-
      search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.withads.unknown.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_WITHADS_UNKNOWN

browser.search.adclicks:
  urlbar:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was started
      from the urlbar. The key format is ‘<provider>:<tagged|organic>’ See
      https://firefox-source-
      docs.mozilla.org/browser/search/telemetry.html#browser-search-
      content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.urlbar.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_URLBAR

  urlbar_handoff:
    type: labeled_counter
    description: >
      The count URI loads triggered in a subsession from the urlbar via
      handoff, broken down by the originating action.
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.urlbar_handoff.
    bugs:
      - https://bugzil.la/1732429
    data_reviews:
      - https://bugzil.la/1732429
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_URLBAR_HANDOFF

  urlbar_persisted:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was started
      from the urlbar after the search term was shown in the urlbar. The
      key format is ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.urlbar_persisted.
    bugs:
      - https://bugzil.la/1779471
    data_reviews:
      - https://bugzil.la/1779471
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_URLBAR_PERSISTED

  urlbar_searchmode:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was started
      from the urlbar in search mode. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.urlbar_searchmode.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_URLBAR_SEARCHMODE

  searchbar:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was started
      from the search bar. The key format is ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.searchbar.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_SEARCHBAR

  about_home:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was started
      from about:home. The key format is ‘<provider>:<tagged|organic>’ See
      https://firefox-source-
      docs.mozilla.org/browser/search/telemetry.html#browser-search-
      content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.about_home.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_ABOUT_HOME

  about_newtab:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was started
      from about:newtab. The key format is ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.about_newtab.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_ABOUT_NEWTAB

  contextmenu:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was started
      from the context menu. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.contextmenu.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_CONTEXTMENU

  webextension:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was started
      from a webextension. The key format is ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.webextension.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_WEBEXTENSION

  system:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was started
      from the system, e.g. command line. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.system.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_SYSTEM

  tabhistory:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was loaded
      from the tab history. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.tabhistory.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_TABHISTORY

  reload:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was loaded
      by reloading the page. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.reload.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_RELOAD

  unknown:
    type: labeled_counter
    description: >
      Records clicks of adverts on SERP pages where the search was started
      from a place not categorized by the other scalars. The key format is
      ‘<provider>:<tagged|organic>’
      See https://firefox-source-docs.mozilla.org/browser/search/telemetry.html#browser-search-content
      This metric was generated to correspond to the Legacy Telemetry
      scalar browser.search.adclicks.unknown.
    bugs:
      - https://bugzil.la/1664847
    data_reviews:
      - https://bugzil.la/1664847
    notification_emails:
      - fx-search-telemetry@mozilla.com
      - rev-data@mozilla.com
    expires: never
    telemetry_mirror: BROWSER_SEARCH_ADCLICKS_UNKNOWN

urlbar.searchmode:
  bookmarkmenu:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after selecing the Search Bookmarks menu item in the
      Library menu.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.bookmarkmenu.
    bugs:
      - https://bugzil.la/1665076
    data_reviews:
      - https://bugzil.la/1665076
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_BOOKMARKMENU

  handoff:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after being handed off from the search bar on the new
      tab page.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.handoff.
    bugs:
      - https://bugzil.la/1654680
      - https://bugzil.la/1665076
    data_reviews:
      - https://bugzil.la/1654680
      - https://bugzil.la/1665076
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_HANDOFF

  keywordoffer:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after selecting a keyword offer result. The scalar key
      for local search modes entered using a restrict keyword will be
      suffixed with "keyword". For example: tabs_keyword,
      bookmarks_keyword, history_keyword, and actions_keyword.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.keywordoffer.
    bugs:
      - https://bugzil.la/1654680
      - https://bugzil.la/1919180
    data_reviews:
      - https://bugzil.la/1654680
      - https://bugzil.la/1919180
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_KEYWORDOFFER

  oneoff:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after selecting a one-off.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.oneoff.
    bugs:
      - https://bugzil.la/1654680
    data_reviews:
      - https://bugzil.la/1654680
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_ONEOFF

  searchbutton:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode by unified search button.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.searchbutton.
    bugs:
      - https://bugzil.la/1919857
    data_reviews:
      - https://bugzil.la/1919857
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_SEARCHBUTTON

  shortcut:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after pressing a keyboard shortcut.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.shortcut.
    bugs:
      - https://bugzil.la/1654680
    data_reviews:
      - https://bugzil.la/1654680
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_SHORTCUT

  tabmenu:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after selecting the Search Tabs menu item in the Tab
      Overflow menu.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.tabmenu.
    bugs:
      - https://bugzil.la/1665076
    data_reviews:
      - https://bugzil.la/1665076
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_TABMENU

  tabtosearch:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after selecting a tab-to-search result.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.tabtosearch.
    bugs:
      - https://bugzil.la/1647923
    data_reviews:
      - https://bugzil.la/1647923
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_TABTOSEARCH

  tabtosearch_onboard:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after selecting a tab-to-search onboarding result.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.tabtosearch_onboard.
    bugs:
      - https://bugzil.la/1665934
    data_reviews:
      - https://bugzil.la/1665934
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_TABTOSEARCH_ONBOARD

  topsites_newtab:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after selecting a search shortcut Top Site on the New
      Tab Page.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.topsites_newtab.
    bugs:
      - https://bugzil.la/1654680
    data_reviews:
      - https://bugzil.la/1654680
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_TOPSITES_NEWTAB

  topsites_urlbar:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after selecting a search shortcut Top Site in the
      Urlbar.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.topsites_urlbar.
    bugs:
      - https://bugzil.la/1654680
    data_reviews:
      - https://bugzil.la/1654680
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_TOPSITES_URLBAR

  touchbar:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after selecting a search shortcut on the macOS Touch
      Bar.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.touchbar.
    bugs:
      - https://bugzil.la/1657414
    data_reviews:
      - https://bugzil.la/1657414
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_TOUCHBAR

  typed:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after typing an alias. The scalar keys for local search
      modes entered by typing a restrict keyword will be suffixed with
      "keyword". For example: tabs_keyword, bookmarks_keyword,
      history_keyword, and actions_keyword. If instead search mode was
      entered by typing a restrict symbol the key will be suffixed with
      "symbol" (e.g. typing "%" will generate "tabs_symbol").
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.typed.
    bugs:
      - https://bugzil.la/1654680
      - https://bugzil.la/1919180
    data_reviews:
      - https://bugzil.la/1654680
      - https://bugzil.la/1919180
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_TYPED

  historymenu:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode after selecing the Search History menu item in a History
      menu.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.historymenu.
    bugs:
      - https://bugzil.la/1736939
    data_reviews:
      - https://bugzil.la/1736939
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_HISTORYMENU

  other:
    type: labeled_counter
    description: >
      A keyed uint recording how many times the user entered a particular
      search mode from an unknown entry point. If values appear for this
      probe in Telemetry, we should review the entry points to search
      mode.
      This metric was generated to correspond to the Legacy Telemetry
      scalar urlbar.searchmode.other.
    bugs:
      - https://bugzil.la/1654680
    data_reviews:
      - https://bugzil.la/1654680
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: URLBAR_SEARCHMODE_OTHER

searchbar:
  selected_result_method:
    type: labeled_counter
    description: >
      The input method the user used to select a result in the searchbar.
      'enter' => The user hit the Enter key without choosing a result in the
      popup. 'enterSelection' => The user chose a result and then hit the Enter
      key. 'click' => The user clicked a result with the mouse.

      This metric was generated to correspond to the Legacy Telemetry
      categorical histogram FX_SEARCHBAR_SELECTED_RESULT_METHOD.
    labels:
      - enter
      - enterSelection
      - click
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1334615
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1334615
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: h#FX_SEARCHBAR_SELECTED_RESULT_METHOD