# 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/.
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0

no_lint:
  - CATEGORY_GENERIC

events:
  app_opened:
    type: event
    description: |
      A user opened the app (from cold start, to the homescreen or browser)
    extra_keys:
      source:
        description: |
          The method used to open Fenix. Possible values are: `app_icon`,
          `custom_tab` or `link`
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/968
      - https://github.com/mozilla-mobile/fenix/issues/10616
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - telemetry-client-dev@mozilla.com
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance
  search_bar_tapped:
    type: event
    description: |
      A user tapped the search bar
    extra_keys:
      source:
        description: |
          The view the user was on when they initiated the search (For example:
          `Home` or `Browser`)
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/959
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  entered_url:
    type: event
    description: |
      A user entered a url
    extra_keys:
      autocomplete:
        description: |
          A boolean that tells us whether the URL was autofilled by an
          Autocomplete suggestion
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/959
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  performed_search:
    type: event
    description: |
      A user performed a search
    extra_keys:
      source:
        description: |
          A string that tells us how the user performed the search. Possible
          values are:

          * default.action
          * default.suggestion
          * shortcut.action
          * shortcut.suggestion
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/959
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
      - https://github.com/mozilla-mobile/fenix/pull/1677
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  browser_menu_action:
    type: event
    description: |
      A browser menu item was tapped.
      The name of the item that the user tapped is stored in extras with the
      key `item`.
    extra_keys:
      item:
        description: |
          A string containing the name of the item the user tapped. These items
          include:
          add_to_homescreen, add_to_top_sites, addons_manager, back, bookmark,
          bookmarks, desktop_view_off, desktop_view_on, downloads,
          find_in_page, forward, help, history, library, new_private_tab,
          new_tab, open_in_app, open_in_fenix, quit, reader_mode_appearance,
          reader_mode_off, reader_mode_on, reload, remove_from_top_sites,
          save_to_collection, set_default_browser, settings, share, stop,
          sync_account, and sync_tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1024
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708
      - https://github.com/mozilla-mobile/fenix/pull/5098#issuecomment-529658996
      - https://github.com/mozilla-mobile/fenix/pull/6310
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-12-01"
  default_browser_changed:
    type: event
    description: |
      Indicates the default browser was changed
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18857
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18982#pullrequestreview-635098629
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Toolbar
  default_browser_notif_tapped:
    type: event
    description: |
      User tapped on the default browser notification
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19847
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20311
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-08-01"
  toolbar_menu_visible:
    type: event
    description: |
      The browser menu was displayed from toolbar menu
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18855
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18982#pullrequestreview-635098629
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-04-01"
    metadata:
      tags:
        - Toolbar
  normal_and_private_uri_count:
    type: counter
    description: |
      A counter of URIs visited by the user in the current session, including
      page reloads. This includes private browsing.  This does not include
      background page requests and URIs from embedded pages but may be
      incremented without user interaction by website scripts that
      programmatically redirect to a new location.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/17089
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/17935
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - PrivateBrowsing
  preference_toggled:
    type: event
    description: |
      A user toggled a boolean preference in settings
    extra_keys:
      preference_key:
        description: |
          The preference key for the boolean (true/false) preference the user
          toggled.

          We currently track: show_search_suggestions, remote_debugging,
          telemetry, tracking_protection, search_bookmarks,
          search_browsing_history, show_clipboard_suggestions,
          show_search_shortcuts, open_links_in_a_private_tab (bug in
          implementation https://github.com/mozilla-mobile/fenix/issues/7384),
          pref_key_sync_logins, pref_key_sync_bookmarks, pref_key_sync_history,
          pref_key_show_voice_search,
          and pref_key_show_search_suggestions_in_private.
      enabled:
        description: "Whether or not the preference is *now* enabled"
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/975
      - https://github.com/mozilla-mobile/fenix/issues/5094
      - https://github.com/mozilla-mobile/fenix/issues/5737
      - https://github.com/mozilla-mobile/fenix/issues/5586
      - https://github.com/mozilla-mobile/fenix/issues/6396
      - https://github.com/mozilla-mobile/fenix/issues/6070
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1896
      - https://github.com/mozilla-mobile/fenix/pull/5704
      - https://github.com/mozilla-mobile/fenix/pull/5886
      - https://github.com/mozilla-mobile/fenix/pull/5975
      - https://github.com/mozilla-mobile/fenix/pull/6352
      - https://github.com/mozilla-mobile/fenix/pull/6601
      - https://github.com/mozilla-mobile/fenix/pull/6746
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
        - History
        - Logins
        - PrivateBrowsing
        - Search
  whats_new_tapped:
    type: event
    description: |
      A user opened the "what's new" page button
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5021
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5090
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-12-01"
  opened_link:
    type: event
    description: |
      A user opened a link with Fenix
    extra_keys:
      mode:
        description: |
          The mode the link was opened in. Either 'PRIVATE' or 'NORMAL'. N.B.:
          this probe may be incorrectly implemented: see
          https://github.com/mozilla-mobile/fenix/issues/14133
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5737
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5975
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - PrivateBrowsing
  synced_tab_opened:
    type: event
    description: |
      An event that indicates that a synced tab was opened.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/15369
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16727
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - SyncTabs
  recently_closed_tabs_opened:
    type: event
    description: |
      An event that indicates that the user
      has accessed recently closed tabs list.
      Deprecated in favor of "recently_closed_tabs.opened"
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/15366
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16739
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  copy_url_tapped:
    type: event
    description: |
      An event that indicates that a user has selected
      copy option when long pressing on url bar.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/16827
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16915
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - ContextMenu
  browser_toolbar_home_tapped:
    type: event
    description: |
      An event that indicates that a user has tapped
      home button on browser toolbar.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19915
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/19936
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-12-10"
  tab_view_changed:
    type: event
    description: |
      Indicates that the user has changed their tab view
      settings, either from the default or by personal
      preference.
    extra_keys:
      type:
        description: |
          A string containing the name of the tab view the user tapped.
          These items include: list or grid.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19956
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/19959#issuecomment-882539619
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-05-10"

onboarding:
  fxa_auto_signin:
    type: event
    description:
      The onboarding automatic sign in card was tapped.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  fxa_manual_signin:
    type: event
    description:
      The onboarding manual sign in card was tapped.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  privacy_notice:
    type: event
    description:
      The onboarding privacy notice card was tapped.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  pref_toggled_toolbar_position:
    type: event
    description:
      The toolbar position preference was chosen from the onboarding card.
    extra_keys:
      position:
        description: |
          A string that indicates the position of the toolbar TOP or BOTTOM.
          Default: BOTTOM
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  pref_toggled_tracking_prot:
    type: event
    description:
      The tracking protection preference was chosen from the onboarding card.
    extra_keys:
      setting:
        description: |
          A string that indicates the Tracking Protection policy STANDARD
          or STRICT. Default: Toggle ON, STANDARD
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  pref_toggled_theme_picker:
    type: event
    description:
      The device theme was chosen using the theme picker onboarding card.
    extra_keys:
      theme:
        description: |
          A string that indicates the theme LIGHT, DARK, or FOLLOW DEVICE.
          Default: FOLLOW DEVICE
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  finish:
    type: event
    description:
      The user taps starts browsing and ends the onboarding experience.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding

search_shortcuts:
  selected:
    type: event
    description: |
      A user selected a search shortcut engine to use
    extra_keys:
      engine:
        description: |
          The name of the built-in search engine the user selected as a string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/793
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1202#issuecomment-476870449
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Search
        - Shortcuts

experiments_default_browser:
  toolbar_menu_clicked:
    type: event
    description: |
      Set default browser was clicked from toolbar menu
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18851
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18982#pullrequestreview-635098629
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
      - https://github.com/mozilla-mobile/fenix/pull/23786#issuecomment-1042331298
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-03-31"
toolbar_settings:
  changed_position:
    type: event
    description: |
      The user selected a new position for the toolbar
    extra_keys:
      position:
        description: |
          A string that indicates the new position of the toolbar TOP or BOTTOM
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6054
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6608
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Toolbar

context_menu:
  item_tapped:
    type: event
    description: |
      A user tapped an item in the browsers context menu
    extra_keys:
      named:
        description: |
          The name of the item that was tapped. Available items are:

          ```
          open_in_new_tab, open_in_private_tab, open_image_in_new_tab,
          save_image, share_link, copy_link, copy_image_location, share_image
          ```
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/957
      - https://github.com/mozilla-mobile/fenix/issues/16076
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/issues/16076#issuecomment-726216734
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - ContextMenu
        - Sharing

login_dialog:
  displayed:
    type: event
    description: |
      The login dialog prompt was displayed
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9730
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/13050
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins
  cancelled:
    type: event
    description: |
      The login dialog prompt was cancelled
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9730
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/13050
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins
  saved:
    type: event
    description: |
      The login dialog prompt "save" button was pressed
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9730
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/13050
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins
  never_save:
    type: event
    description: |
      The login dialog prompt "never save" button was pressed
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9730
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/13050
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins

metrics:
  default_browser:
    type: boolean
    lifetime: application
    description: |
      Is Fenix the default browser?
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/960
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Settings
  distribution_id:
    type: string
    lifetime: application
    description: |
      A string containing the distribution identifier. This is currently used
      to identify installs from Mozilla Online.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/16075
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/issues/16075
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - China
  mobile_bookmarks_count:
    type: counter
    lifetime: application
    description: |
      A counter that indicates how many bookmarks a user has in the mobile
      folder. This value will only be set if the user has at least *one*
      bookmark. If they have 0, this ping will not get sent, resulting in
      a null value. To disambiguate between a failed `mobile_bookmarks_count`
      ping and 0 bookmarks, please see `has_mobile_bookmarks`.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/16941
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16942
      - https://github.com/mozilla-mobile/fenix/pull/16942#issuecomment-742794701
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  has_mobile_bookmarks:
    type: boolean
    lifetime: application
    description: |
      A boolean that indicates if the user has bookmarks in the mobile folder
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/16941
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16942
      - https://github.com/mozilla-mobile/fenix/pull/16942#issuecomment-742794701
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  desktop_bookmarks_count:
    type: counter
    lifetime: application
    description: |
      A counter that indicates how many bookmarks a user has in the desktop
      folder. This value will only be set if the user has at least *one*
      bookmark. If they have 0, this ping will not get sent, resulting in a
      null value. To disambiguate between a failed `desktop_bookmarks_count`
      ping and 0 bookmarks, please see `has_desktop_bookmarks`.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/16941
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16942
      - https://github.com/mozilla-mobile/fenix/pull/16942#issuecomment-742794701
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  has_desktop_bookmarks:
    type: boolean
    lifetime: application
    description: |
      A boolean that indicates if the user has bookmarks in the desktop folder
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/16941
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16942
      - https://github.com/mozilla-mobile/fenix/pull/16942#issuecomment-742794701
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Bookmarks
  top_sites_count:
    type: counter
    lifetime: application
    description: |
      A counter that indicates how many top sites a user has. This value will
      only be set if the user has at least *one* top site. If they have 0,
      this ping will not get sent, resulting in a null value. To disambiguate
      between a failed `top_sites_count` ping and 0 top sites, please see
      `has_top_sites`.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/8125
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9556
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - TopSites
  has_top_sites:
    type: boolean
    lifetime: application
    description: |
      A boolean that indicates if the user has top sites
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/8125
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9556
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - TopSites
  recently_used_pwa_count:
    type: counter
    lifetime: application
    description: |
      A counter that indicates how many PWAs a user has recently used.
      Threshold for "recency" set in HomeActivity#PWA_RECENTLY_USED_THRESHOLD.
      Currently we are not told by the OS when a PWA is removed by the user,
      so we use the "recently used" heuristic to judge how many PWAs are still
      active, as a proxy for "installed". This value will only be set if the
      user has at least *one* recently used PWA. If they have 0, this metric
      will not be sent, resulting in a null value during analysis on the
      server-side. To disambiguate between a failed `recently_used_pwa_count`
      metric and 0 recent PWAs, please see `has_recent_pwas`.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11909
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11982#pullrequestreview-437963817
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - PWA
  has_recent_pwas:
    type: boolean
    lifetime: application
    description: |
      A boolean that indicates if the user has recently used PWAs.
      See recently_used_pwa_count for the actual count.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11909
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11982#pullrequestreview-437963817
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - PWA
  search_count:
    type: labeled_counter
    description: |
      The labels for this counter are `<search-engine-name>.<source>`.

      If the search engine is bundled with Fenix `search-engine-name` will be
      the name of the search engine. If it's a custom search engine (defined:
      https://github.com/mozilla-mobile/fenix/issues/1607) the value will be
      `custom`.

      `source` will be: `action`, `suggestion`, `widget`, `shortcut`, `topsite`
      (depending on the source from which the search started). Also added the
      `other` option for the source but it should never enter on this case.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1158
      - https://github.com/mozilla-mobile/fenix/issues/6556
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1677
      - https://github.com/mozilla-mobile/fenix/pull/5216
      - https://github.com/mozilla-mobile/fenix/pull/7310
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  mozilla_products:
    type: string_list
    lifetime: application
    description: |
      A list of all the Mozilla products installed on device. We currently scan
      for: Firefox, Firefox Beta, Firefox Aurora, Firefox Nightly, Firefox
      Fdroid, Firefox Lite, Reference Browser, Reference Browser Debug, Fenix,
      Focus, and Lockwise.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1192
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1953/
      - https://github.com/mozilla-mobile/fenix/pull/5216
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Settings
  default_moz_browser:
    type: string
    lifetime: application
    description: |
      The name of the default browser on device if and only if it's a Mozilla
      owned product
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1192
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1953/
      - https://github.com/mozilla-mobile/fenix/pull/5216
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Settings
  adjust_campaign:
    type: string
    lifetime: application
    description: |
      A string containing the Adjust campaign ID from which the user installed
      Fenix. This will not send on the first session the user runs. If the
      install is organic, this will be empty.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1298
      - https://github.com/mozilla-mobile/fenix/issues/9136
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5579
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Telemetry
  adjust_ad_group:
    type: string
    lifetime: application
    description: |
      A string containing the Adjust ad group ID from which the user installed
      Fenix. This will not send on the first session the user runs. If the
      install is organic, this will be empty.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1298
      - https://github.com/mozilla-mobile/fenix/issues/9136
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9253
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Telemetry
  adjust_creative:
    type: string
    lifetime: application
    description: |
      A string containing the Adjust creative ID from which the user installed
      Fenix. This will not send on the first session the user runs. If the
      install is organic, this will be empty.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1298
      - https://github.com/mozilla-mobile/fenix/issues/9136
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9253
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Telemetry
  adjust_network:
    type: string
    lifetime: application
    description: |
      A string containing the Adjust network ID from which the user installed
      Fenix. This will not send on the first session the user runs. If the
      install is organic, this will be empty.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1298
      - https://github.com/mozilla-mobile/fenix/issues/9136
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9253
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Telemetry
  toolbar_position:
    type: string
    lifetime: application
    description: |
      A string that indicates the new position of the toolbar TOP or BOTTOM
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6054
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6608
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Toolbar
  close_tab_setting:
    type: string
    lifetime: application
    description: |
      A string that indicates the setting for tab closing:
      MANUAL, ONE_DAY, ONE_WEEK, ONE_MONTH
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/15347#issue-707408975
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/15811#issuecomment-706402952
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Tabs
  tab_view_setting:
    type: string
    lifetime: application
    description: |
      A string that indicates the setting for tab view:
      GRID, LIST
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/15347#issue-707408975
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/15811#issuecomment-706402952
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Tabs
  search_widget_installed:
    type: boolean
    lifetime: application
    description: |
      Whether or not the search widget is installed
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9488
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10958
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Discovery
        - Search
  tabs_open_count:
    type: counter
    lifetime: application
    description: |
      A counter that indicates how many NORMAL tabs a user has open. This
      value will only be set if the user has at least *one* open tab. If they
      have 0, this ping will not get sent, resulting in a null value. To
      disambiguate between a failed `tabs_open_count` ping and 0 open tabs,
      please see `has_open_tabs`.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11479
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12024
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  has_open_tabs:
    type: boolean
    lifetime: application
    description: |
      A boolean that indicates if the user has any open NORMAL tabs.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11479
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12024
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Tabs
  start_reason_process_error:
    type: boolean
    description: |
      The `AppStartReasonProvider.ProcessLifecycleObserver.onCreate` was
      unexpectedly called twice. We can use this metric to validate our
      assumptions about how these APIs are called. This probe can be removed
      once we validate these assumptions.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18426
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18632#issue-600193452
      - https://github.com/mozilla-mobile/fenix/pull/20623#issue-701630599
      - https://github.com/mozilla-mobile/fenix/pull/23506
    data_sensitivity:
      - technical
    notification_emails:
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance
  start_reason_activity_error:
    type: boolean
    description: |
      The `AppStartReasonProvider.ActivityLifecycleCallbacks.onActivityCreated`
      was unexpectedly called twice. We can use this metric to validate our
      assumptions about how these APIs are called. This probe can be removed
      once we validate these assumptions.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18426
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18632#issue-600193452
      - https://github.com/mozilla-mobile/fenix/pull/20623#issue-701630599
      - https://github.com/mozilla-mobile/fenix/pull/23506
    data_sensitivity:
      - technical
    notification_emails:
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance
  install_source:
    type: string
    lifetime: application
    description: |
      Used to identify the source the app was installed from.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22138
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22224#issuecomment-956749994
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
  inactive_tabs_count:
    type: quantity
    description: |
      How many inactive tabs does the user have, checked when the user opens
      the tabs tray.
      Value will be 0 if the feature is disabled.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22155
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22163#issuecomment-957636802
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    unit: integer

customize_home:
  most_visited_sites:
    type: boolean
    description: |
      An indication of whether the most visited sites
      are enabled to be displayed
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21239
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21344
      - https://github.com/mozilla-mobile/fenix/pull/21344#issuecomment-923198787
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-20"
  jump_back_in:
    type: boolean
    description: |
      An indication of whether the Jump back
      in section is enabled to be displayed
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21239
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21344
      - https://github.com/mozilla-mobile/fenix/pull/21344#issuecomment-923198787
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-20"
  recently_saved:
    type: boolean
    description: |
      An indication of whether the recently
      saved section is enabled to be displayed
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21239
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21344
      - https://github.com/mozilla-mobile/fenix/pull/21344#issuecomment-923198787
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-20"
  recently_visited:
    type: boolean
    description: |
      An indication of whether the Recently
      visited section is enabled to be displayed
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21239
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21344
      - https://github.com/mozilla-mobile/fenix/pull/21344#issuecomment-923198787
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-20"
  pocket:
    type: boolean
    description: |
      An indication of whether Pocket is enabled to be displayed
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21239
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21344
      - https://github.com/mozilla-mobile/fenix/pull/21344#issuecomment-923198787
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-20"
  preference_toggled:
    type: event
    description: |
      A user toggles the preference for the home screen items.
    extra_keys:
      preference_key:
        description: |
          The preference key for the boolean (true/false) preference the user
          toggled.

          We currently track: most_visited_sites, jump_back_in,
          recently_visited, recently_saved, and pocket.
      enabled:
        description: "Whether or not the preference is *now* enabled"
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21095
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1896
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-20"
  opening_screen:
    type: string
    description: |
      What opening screen preference the user has selected
      under "Customize Home".
      "homepage," "last tab," or "homepage after 4 hours"
      default: "homepage after 4 hours"
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22145
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22333
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"

preferences:
  studies_enabled:
    type: boolean
    description: >
      A metric indicating whether or not the user has studies enabled
      default: true
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22192
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22193
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  studies_preference_enabled:
    type: event
    description: >
      An event indicating whether or not the user has studies enabled.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22192
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22193
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  search_suggestions_enabled:
    type: boolean
    description: |
      Whether or not the user has search suggestions enabled
      default: true
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
        - Settings
  remote_debugging_enabled:
    type: boolean
    description: |
      Whether or not the user has remote debugging enabled
      default: false
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Settings
  telemetry_enabled:
    type: boolean
    description: |
      Whether or not the user has telemetry enabled. Note we should
      never receive a "false" value for this since telemetry would
      not send in that case.
      default: true
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Telemetry
        - Settings
  enhanced_tracking_protection:
    type: string
    description: |
      What type of enhanced tracking protection the user has enabled.
      "standard," "strict," "custom," or "" (if disabled)
      default: "standard"
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - TrackingProtection
        - Settings
  bookmarks_suggestion:
    type: boolean
    description: |
      Whether or not the user has enabled bookmark search suggestions
      default: true
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Settings
  browsing_history_suggestion:
    type: boolean
    description: |
      Whether or not the user has enabled browsing history suggestions.
      default: true
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Settings
  clipboard_suggestions_enabled:
    type: boolean
    description: |
      Whether or not the user has enabled clipboard search suggestions.
      default: true
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Settings
  search_shortcuts_enabled:
    type: boolean
    description: |
      Whether or not the user has enabled search shortcuts.
      default: true
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
        - Settings
  signed_in_sync:
    type: boolean
    description: |
      Whether or not the user is signed into FxA
      default: false
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Sync
        - Settings
  sync_items:
    type: string_list
    description: |
      The list of items the user has chosen to sync with FxA.
      default: "" if the user is signed out. Otherwise defaults to
      whatever is set in their FxA account. New accounts set:
      [bookmarks, history, passwords, tabs]
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Settings
  voice_search_enabled:
    type: boolean
    description: |
      Whether or not the user has enabled the voice search button.
      default: true
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Search
        - Voice
        - Settings
  toolbar_position_setting:
    type: string
    description: |
      The position of the toolbar
      default: bottom (defaults to top if the user has accessibility services)
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Toolbar
        - Settings
  accessibility_services:
    type: string_list
    description: |
      Whether or not the user has touch exploration or switch services enabled.
      These are built into the Android OS, not Fenix prefs.
      default: ""
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Settings
  open_links_in_app_enabled:
    type: boolean
    description: |
      Whether or not the user has the open links in apps feature enabled.
      default: false
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11446
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Settings
  user_theme:
    type: string
    description: |
      The theme the user has enabled. "light," "dark," "system," or "battery"
      default: "system" for API 28+, else "light"
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11446
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Themes
        - Settings
  inactive_tabs_enabled:
    type: boolean
    description: |
      Whether or not the user has the inactive tabs feature enabled.
      default: true
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21903
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21908
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  inactive_tabs_survey_opened:
    type: event
    description: >
      A survey for asking the user why she intends to turn off the
      inactive tabs feature is shown.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21732
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21862#issuecomment-949598042
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
  turn_off_inactive_tabs_survey:
    type: event
    description: >
      The user has disabled inactive tabs feature and responded
      to our request for feedback.
    extra_keys:
      feedback:
        description: |
          The user's feedback regarding inactive tabs feature.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21732
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21862#issuecomment-946977614
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
  search_term_groups_enabled:
    type: boolean
    description: |
      Is search term group in tabs tray on?
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22057
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22058
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"

search.default_engine:
  code:
    type: string
    lifetime: application
    description: |
      If the search engine is pre-loaded with Fenix this value
      will be the search engine identifier. If it's a custom search engine
      (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the
      value will be "custom"
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/800
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1606
      - https://github.com/mozilla-mobile/fenix/pull/5216
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
  name:
    type: string
    lifetime: application
    description: |
      If the search engine is pre-loaded with Fenix this value
      will be the search engine name. If it's a custom search engine
      (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the
      value will be "custom"
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/800
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1606
      - https://github.com/mozilla-mobile/fenix/pull/5216
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
  search_url:
    type: url
    lifetime: application
    description: |
      If the search engine is pre-loaded with Fenix this value will be the base
      URL we use to build the search query for the search engine. For example:
      https://mysearchengine.com/?query=%s. If it's a custom search engine
      (defined: https://github.com/mozilla-mobile/fenix/issues/1607) the value
      will not be set.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/800
      - https://github.com/mozilla-mobile/fenix/issues/20513
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1606
      - https://github.com/mozilla-mobile/fenix/pull/5216
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"

bookmarks_management:
  open:
    type: event
    description: |
      A user opened a bookmark.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18173
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18174
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-08-01"
    metadata:
      tags:
        - Bookmarks
  open_in_new_tab:
    type: event
    description: |
      A user opened a bookmark in a new tab.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  open_in_new_tabs:
    type: event
    description: |
      A user opened multiple bookmarks at once in new tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  open_in_private_tab:
    type: event
    description: |
      A user opened a bookmark in a new private tab.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  open_in_private_tabs:
    type: event
    description: |
      A user opened multiple bookmarks at once in new private tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  edited:
    type: event
    description: |
      A user edited the title and/or URL of an existing bookmark.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  moved:
    type: event
    description: |
      A user moved an existing bookmark or folder to another folder.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  removed:
    type: event
    description: |
      A user removed a bookmark item.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  multi_removed:
    type: event
    description: |
      A user removed multiple bookmarks at once.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  shared:
    type: event
    description: |
      A user shared a bookmark.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  copied:
    type: event
    description: |
      A user copied a bookmark.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  folder_add:
    type: event
    description: |
      A user added a new bookmark folder.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/974
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1708
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  folder_remove:
    type: event
    description: |
      A user removed a bookmark folder.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/3174
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3724
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never

    metadata:
      tags:
        - Bookmarks
custom_tab:
  closed:
    type: event
    description: |
      A user closed the custom tab
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/977
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1697
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-06-01"
    metadata:
      tags:
        - CustomTabs
  action_button:
    type: event
    description: |
      A user pressed the action button provided by the launching app
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/977
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1697
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-06-01"
    metadata:
      tags:
        - CustomTabs
  menu:
    type: event
    description: |
      A user opened the custom tabs menu
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/977
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1697
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-06-01"
    metadata:
      tags:
        - CustomTabs

activation:
  identifier:
    type: string
    lifetime: ping
    description: |
      A hashed and salted version of the Google Advertising ID from the device.
      This will never be sent in a ping that also contains the client_id.
    send_in_pings:
      - activation
    bugs:
      - https://bugzilla.mozilla.org/1538011
      - https://bugzilla.mozilla.org/1501822
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1707#issuecomment-486972209
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21788#issuecomment-950022224
    data_sensitivity:
      - highly_sensitive
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security
  activation_id:
    type: uuid
    lifetime: user
    description: |
      An alternate identifier, not correlated with the client_id, generated once
      and only sent with the activation ping.
    send_in_pings:
      - activation
    bugs:
      - https://bugzilla.mozilla.org/1538011
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/1707#issuecomment-486972209
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21788#issuecomment-950022224
    data_sensitivity:
      - highly_sensitive
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    no_lint:
      - USER_LIFETIME_EXPIRATION
    metadata:
      tags:
        - Privacy&Security

error_page:
  visited_error:
    type: event
    description: |
      A user encountered an error page
    extra_keys:
      error_type:
        description: "The error type of the error page encountered"
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1242
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/2491#issuecomment-492414486
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-12-01"
    metadata:
      tags:
        - ErrorMessages

sync_auth:
  opened:
    type: event
    description: |
      A user opened the sync authentication page
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1190
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/2745#issuecomment-494918532
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Toolbar
        - Sync
  closed:
    type: event
    description: |
      A user closed the sync page
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1190
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/2745#issuecomment-494918532
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Toolbar
        - Sync
  use_email:
    type: event
    description: |
      A user chose to use their email to sign in instead of scanning a QR code,
      counterpart to "scan_pairing"
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9834
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9835#pullrequestreview-398641844
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Sync
  use_email_problem:
    type: event
    description: |
      A user chose to use their email to sign in after an account problem
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9834
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9835#pullrequestreview-398641844
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Sync
  sign_in:
    type: event
    description: |
      A user pressed the sign in button on the sync authentication page and was
      successfully signed in to FxA
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1190
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/2745#issuecomment-494918532
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Sync
  sign_out:
    type: event
    description: |
      A user pressed the sign out button on the sync account page and was
      successfully signed out of FxA
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1190
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/2745#issuecomment-494918532
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Sync
  sign_up:
    type: event
    description: |
      User registered a new Firefox Account, and was signed into it
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4971
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4931#issuecomment-529740300
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Accounts
  paired:
    type: event
    description: |
      User signed into FxA by pairing with a different Firefox browser, using a
      QR code
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4971
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4931#issuecomment-529740300
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Accounts
  recovered:
    type: event
    description: |
      Account manager automatically recovered FxA authentication state without
      direct user involvement
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4971
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4931#issuecomment-529740300
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Accounts
  other_external:
    type: event
    description: |
      User authenticated via FxA using an unknown mechanism. "Known" mechanisms
      are currently sign-in, sign-up and pairing
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4971
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4931#issuecomment-529740300
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Accounts
  scan_pairing:
    type: event
    description: |
      A user pressed the scan pairing button on the sync authentication page
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1190
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/2745#issuecomment-494918532
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Sync

sync_account:
  opened:
    type: event
    description: |
      A user opened the sync account page
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1190
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/2745#issuecomment-494918532
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Toolbar
        - Sync
  sync_now:
    type: event
    description: |
      A user pressed the sync now button on the sync account page
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1190
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/2745#issuecomment-494918532
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Toolbar
        - Sync
  send_tab:
    type: event
    description: |
      A user sent the current tab to another FxA device
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4908
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5106
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - SendTab
  sign_in_to_send_tab:
    type: event
    description: |
      A user pressed the "sign in to send tab" button inside the share tab menu
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4908
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5106
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - SendTab

history:
  opened:
    type: event
    description: |
      A user opened the history screen
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/2362
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3940
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - History
  removed:
    type: event
    description: |
      A user removed a history item
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/2362
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3940
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - History
  removed_all:
    type: event
    description: |
      A user removed all history items
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/2362
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3940
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - History
  shared:
    type: event
    description: |
      A user shared a history item
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/2362
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3940
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - History
  opened_item:
    type: event
    description: |
      A user opened a history item
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18178
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18261
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - History
  opened_item_in_new_tab:
    type: event
    description: |
      A user opened a history item in a new tab
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18178
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18261
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - History
  opened_items_in_new_tabs:
    type: event
    description: |
      A user opened multiple history items in new tabs
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18178
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18261
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - History
  opened_item_in_private_tab:
    type: event
    description: |
      A user opened a history item in a private tab
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18178
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18261
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - History
  opened_items_in_private_tabs:
    type: event
    description: |
      A user opened multiple history items in private tabs
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18178
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18261
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - History
  recent_searches_tapped:
    type: event
    description: |
      User has tapped on an item in the "Recently visited" section on home.
    extra_keys:
      page_number:
        description: |
          The page number in the homescreen carousel that the recently visited
          item was on.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22172
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22173
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  search_term_group_tapped:
    type: event
    description: |
      A user tapped on a search term group in history
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22299
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22300
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  search_term_group_open_tab:
    type: event
    description: |
      A user opens a tab from the search term group in history.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22147
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22368#issuecomment-964223263
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  search_term_group_remove_tab:
    type: event
    description: |
      A user closes a single tab in the search term group in history.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22147
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22368#issuecomment-964223263
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  search_term_group_remove_all:
    type: event
    description: |
      A user closes all tabs in the search term group in history.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22147
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22368#issuecomment-964223263
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  search_icon_tapped:
    type: event
    description: |
      A user tapped on the search icon in history.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23694
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23695
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-03-31"
  search_result_tapped:
    type: event
    description: |
      A user tapped on the search result in history.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23694
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23695
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-03-31"

recently_closed_tabs:
  opened:
    type: event
    description: |
      User opened the "Recently closed tabs" screen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  closed:
    type: event
    description: |
      User closed the "Recently closed tabs" screen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  show_full_history:
    type: event
    description: |
      User tapped "Show full history" to see all history.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  open_tab:
    type: event
    description: |
      User tapped on a tab item to be opened.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  delete_tab:
    type: event
    description: |
      User tapped the delete button of a tab item.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  menu_close:
    type: event
    description: |
      User tapped the close button - "X" to return to the previous screen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  menu_share:
    type: event
    description: |
      User tapped the share menu option for multi selected tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  menu_delete:
    type: event
    description: |
      User tapped the delete menu option for multi selected tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  menu_open_in_normal_tab:
    type: event
    description: |
      User tapped the "Open in new tab" menu option for multi selected tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  menu_open_in_private_tab:
    type: event
    description: |
      User tapped the "Open in private tab" menu option for multi selected tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  enter_multiselect:
    type: event
    description: |
      User tapped on a tab item to enter multi select mode.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"
  exit_multiselect:
    type: event
    description: |
      User pressed back or tapped the last selected tab item to exit
      multiselect.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21009
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22588#issuecomment-1024352995
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-01-31"

reader_mode:
  available:
    type: event
    description: |
      Reader mode is available for the current page
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/2267
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3941
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - ReaderMode
  opened:
    type: event
    description: |
      A user opened reader mode
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/2267
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3941
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - ReaderMode
  closed:
    type: event
    description: |
      A user closed reader mode
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/2267
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4328
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - ReaderMode
  appearance:
    type: event
    description: |
      A user tapped the appearance button
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/2267
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3941
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
      - erichards@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - ReaderMode

tabs_tray:
  opened:
    type: event
    description: |
      A user opened the tabs tray
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  closed:
    type: event
    description: |
      A user closed the tabs tray
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  opened_existing_tab:
    type: event
    description: |
      A user opened an existing tab from a particular app feature.
    extra_keys:
      source:
        description: |
          From which app feature was an existing tab opened.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/20508#issuecomment-902160532
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  closed_existing_tab:
    type: event
    description: |
      A user closed an existing tab from a particular app feature.
    extra_keys:
      source:
        description: |
          From which app feature was an existing tab closed.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/20508#issuecomment-902160532
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  private_mode_tapped:
    type: event
    description: |
      A user switched to private mode
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  normal_mode_tapped:
    type: event
    description: |
      A user switched to normal mode
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  synced_mode_tapped:
    type: event
    description: |
      A user switched to synced mode
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18948
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/19004
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - SyncTabs
        - Tabs
  new_tab_tapped:
    type: event
    description: |
      A user opened a new tab
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  new_private_tab_tapped:
    type: event
    description: |
      A user opened a new private tab
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  menu_opened:
    type: event
    description: |
      A user opened three three dot menu in the tabs tray
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  save_to_collection:
    type: event
    description: |
      A user tapped the save to collection button in the tabs tray
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
        - Collections
  share_all_tabs:
    type: event
    description: |
      A user tapped the share all tabs button in the
      three dot menu within the tabs tray
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  close_all_tabs:
    type: event
    description: |
      A user tapped the close all tabs button in the
      three dot menu within the tabs tray
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11273
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12036
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  inactive_tabs_expanded:
    type: event
    description: |
      A user tapped the "Inactive tabs" header to expand
      the group of inactive tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/20507
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20508#issuecomment-901336677
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-08-01"
    metadata:
      tags:
        - Tabs
  inactive_tabs_collapsed:
    type: event
    description: |
      A user tapped the "Inactive tabs" header to collapse
      the group of inactive tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/20507
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20508#issuecomment-901336677
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-08-01"
    metadata:
      tags:
        - Tabs
  has_inactive_tabs:
    type: event
    description: |
      A boolean that indicates if the user has any INACTIVE tabs.
    extra_keys:
      inactive_tabs_count:
        description:
          The number of inactive tabs the user currently has.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21903
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21908
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  close_all_inactive_tabs:
    type: event
    description: |
      A user tapped the close all inactive tabs button in the the tabs tray
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21903
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21908
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  auto_close_seen:
    type: event
    description: |
      A user has seen the auto-close dialog for inactive tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22170
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22171
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  auto_close_turn_on_clicked:
    type: event
    description: |
      A user has clicked the turn-on auto-close button for inactive tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22170
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22171
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  auto_close_dimissed:
    type: event
    description: |
      A user has dimissed the auto-close dialog for inactive tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22170
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22171
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  close_inactive_tab:
    type: counter
    description: |
      A counter that indicates how many INACTIVE tabs a user has closed.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21903
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21908
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  open_inactive_tab:
    type: counter
    description: |
      A counter that indicates how many INACTIVE tabs a user has opened.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21903
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21908
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  inactive_tabs_cfr_settings:
    type: event
    description: |
      A user has opened settings via the inactive tabs CFR.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22298
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  inactive_tabs_cfr_dismissed:
    type: event
    description: |
      A user has dismissed the inactive tabs CFR.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22298
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  inactive_tabs_cfr_visible:
    type: event
    description: |
      An indication of whether the inactive tabs CFR is visible.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22298
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"

collections:
  renamed:
    type: event
    description: |
      A user renamed a collection
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3935
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  tab_restored:
    type: event
    description: |
      A user restored a tab from collection tab list
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3935
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  all_tabs_restored:
    type: event
    description: |
      A user tapped "open tabs" from collection menu
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3935
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  tab_removed:
    type: event
    description: |
      A user tapped remove tab from collection tab list
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3935
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  shared:
    type: event
    description: |
      A user tapped share collection
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3935
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  removed:
    type: event
    description: |
      A user tapped delete collection from collection menu
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3935
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  saved:
    type: event
    description: |
      A user saved a list of tabs to a new collection
    extra_keys:
      tabs_open:
        description: "The number of tabs open in the current session"
      tabs_selected:
        description: "The number of tabs added to the collection"
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3935
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  tabs_added:
    type: event
    description: |
      A user saved a list of tabs to an existing collection
    extra_keys:
      tabs_open:
        description: The number of tabs open in the current session
      tabs_selected:
        description: The number of tabs added to the collection
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3935
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  tab_select_opened:
    type: event
    description: |
      A user opened the select tabs screen (the first step of the collection
      creation flow)
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/3935
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  add_tab_button:
    type: event
    description: |
      A user tapped the "add tab" button in the three dot menu of collections
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4358
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  long_press:
    type: event
    description: |
      A user long pressed on a tab, triggering the collection creation screen
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4358
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections
  save_button:
    type: event
    description: |
      A user pressed the "save to collection" button on either the home or
      browser screen, triggering the collection creation screen to open
      (tab_select_opened)
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4358
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    extra_keys:
      from_screen:
        description: |
          A string representing the screen from which the user pressed the save
          button. Currently one of: `browserMenu`, `homeMenu` or `home`
    metadata:
      tags:
        - Collections
  rename_button:
    type: event
    description: |
      A user pressed the "rename collection" button in the three dot menu
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/969
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4539
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Collections

search_widget:
  new_tab_button:
    type: event
    description: |
      A user pressed anywhere from the Firefox logo until the start of the
      microphone icon, opening a new tab search screen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4457
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4714
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Search
  voice_button:
    type: event
    description: |
      A user pressed the microphone icon, opening a new voice search screen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4457
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/4714
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Search

tracking_protection:
  exception_added:
    type: event
    description: |
      A user added a tracking protection exception through the TP toggle in the
      panel.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5312
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5414#issuecomment-532847188
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - TrackingProtection
  panel_settings:
    type: event
    description: |
      A user opened tracking protection settings from the panel.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5312
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5414#issuecomment-532847188
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - TrackingProtection
  etp_shield:
    type: event
    description: |
      A user pressed the tracking protection shield icon in toolbar.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5312
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5414#issuecomment-532847188
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - TrackingProtection
  etp_tracker_list:
    type: event
    description: |
      A user pressed into a list of categorized trackers in tracking protection
      panel.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5312
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5414#issuecomment-532847188
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - TrackingProtection
  etp_settings:
    type: event
    description: |
      A user opened tracking protection settings through settings.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5312
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5414#issuecomment-532847188
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - TrackingProtection
  etp_setting_changed:
    type: event
    description: |
      A user changed their tracking protection level setting to either strict,
      standard, or custom.
    extra_keys:
      etp_setting:
        description: "The new setting for ETP: strict, standard, custom"
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5312
      - https://github.com/mozilla-mobile/fenix/issues/11063
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5414#issuecomment-532847188
      - https://github.com/mozilla-mobile/fenix/pull/11383
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"

    metadata:
      tags:
        - TrackingProtection
tab:
  media_play:
    type: event
    description: |
      A user pressed the play icon on a tab from the home screen
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5197
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5266
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    no_lint:
      - COMMON_PREFIX
    metadata:
      tags:
        - Media
  media_pause:
    type: event
    description: |
      A user pressed the pause icon on a tab from the home screen
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5197
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5266
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Media

media_notification:
  play:
    type: event
    description: |
      A user pressed the play icon on the media notification
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5197
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5520
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Media
  pause:
    type: event
    description: |
      A user pressed the pause icon on the media notification
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5197
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5520
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Media

media_state:
  play:
    type: event
    description: |
      Media started playing.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5705
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6463
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Media
  pause:
    type: event
    description: |
      Media playback was paused.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5705
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6463
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Media
  stop:
    type: event
    description: |
      Media playback has ended.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5705
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6463
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Media
  fullscreen:
    type: event
    description: |
      Video set to fullscreen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/15368
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16833
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Media
  picture_in_picture:
    type: event
    description: |
      Video set to picture in picture mode.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/15368
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16833
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Media

logins:
  open_logins:
    type: event
    description: |
      A user accessed Logins in Settings
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5586
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6352
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Logins
  open_individual_login:
    type: event
    description: |
      A user accessed an individual login in saved logins
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5586
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6352
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins
  copy_login:
    type: event
    description: |
      A user copied a piece of a login in saved logins
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5586
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6352
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins
  view_password_login:
    type: event
    description: |
      A user viewed a password in an individual saved login
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5586
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6352
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins
  save_logins_setting_changed:
    type: event
    description: |
      A user changed their setting for asking to save logins
    extra_keys:
      setting:
        description: |
          The new setting for saving logins the user selected. Either
          `ask_to_save` or `never_save`
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/5586
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/7767
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins
  open_login_editor:
    type: event
    description: |
      A user entered the edit screen for an individual saved login
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10173
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/issues/11208
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins
  delete_saved_login:
    type: event
    description: |
      A user confirms delete of a saved login
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10173
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/issues/11208
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins
  save_edited_login:
    type: event
    description: |
      A user saves changes made to an individual login
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10173
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/issues/11208
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Logins

voice_search:
  tapped:
    type: event
    description: |
      A user selected the voice search button on the search screen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10465
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10785
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Search
        - Voice
top_sites:
  open_default:
    type: event
    description: |
      A user opened a default top site
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/8125
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10752
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - TopSites
  open_google_search_attribution:
    type: event
    description: |
      A user opened the google top site
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/17418
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/17637
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
        - TopSites
  open_baidu_search_attribution:
    type: event
    description: |
      A user opened the baidu top site
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19490
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20705
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - Search
        - TopSites
  open_frecency:
    type: event
    description: |
      A user opened a frecency top site
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/14565
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/15136
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - TopSites
  open_pinned:
    type: event
    description: |
      A user opened a pinned top site
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/14565
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/15136
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - TopSites
  swipe_carousel:
    type: event
    description: |
      A user swiped to change the page of the top sites carousel
    extra_keys:
      page:
        description: |
          The page number the carousel is now on
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/14565
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/15136
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - TopSites
  long_press:
    type: event
    description: |
      A user long pressed on a top site
    extra_keys:
      type:
        description: |
          The type of top site. Options are: "FRECENCY", "DEFAULT",
          "PINNED", or "PROVIDED"
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/14565
      - https://github.com/mozilla-mobile/fenix/issues/23526
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/15136
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
      - https://github.com/mozilla-mobile/fenix/pull/23541
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - TopSites
  open_in_new_tab:
    type: event
    description: |
      A user opens a new tab based on a top site item
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6757
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/7523
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - TopSites
  open_in_private_tab:
    type: event
    description: |
      A user opens a new private tab based on a top site item
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6757
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/7523
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - TopSites
  remove:
    type: event
    description: |
      A user removes a top site item
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6757
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/7523
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - TopSites
  google_top_site_removed:
    type: event
    description: |
      A user removed the default Google top site
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21841
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21845#issuecomment-944608568
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
  baidu_top_site_removed:
    type: event
    description: |
      A user removed the default Baidu top site
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21841
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21845#issuecomment-944608568
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
  open_contile_top_site:
    type: event
    description: |
      A user has opened a contile top site.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23526
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23541
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
  open_contile_in_private_tab:
    type: event
    description: |
      A user has opened a contile top site in a private tab via the long
      press context menu.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23526
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23541
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
  contile_settings:
    type: event
    description: |
      A user has selected "Settings" via the contile top sites
      longpress context menu.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23526
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23541
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
  contile_sponsors_and_privacy:
    type: event
    description: |
      A user has selected "Our sponsors & your privacy" via the
      contile top sites longpress context menu.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23526
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23541
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"

app_theme:
  dark_theme_selected:
    type: event
    description: |
      A user selected Dark Theme
    extra_keys:
      source:
        description: |
          The source from where dark theme was selected. The source can be
          'SETTINGS' or 'ONBOARDING'
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/7289
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/7968
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-12-01"

    metadata:
      tags:
        - Themes
pocket:
  pocket_top_site_clicked:
    type: event
    description: |
      A user clicked on the trending Pocket top site
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/8126
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8098
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    no_lint:
      - COMMON_PREFIX
    metadata:
      tags:
        - PocketIntegration
        - TopSites
  pocket_top_site_removed:
    type: event
    description: |
      A user removed the trending Pocket top site
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/8126
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8098
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - PocketIntegration
        - TopSites
  home_recs_shown:
    type: event
    description: |
      The Pocket recommended stories are shown on the home screen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21593
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21625#issuecomment-936745506
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-10-01"
  home_recs_story_clicked:
    type: event
    description: |
      User tapped a Pocket recommended story to be opened.
    extra_keys:
      times_shown:
        description: |
          How many times was this story shown, including current.
      position:
        description: |
          Position of the clicked story in the list shown.
          Uses the [row x column] matrix notation.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21593
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21625#issuecomment-936745506
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-10-01"
  home_recs_category_clicked:
    type: event
    description: |
      User tapped a Pocket stories category to filter stories.
    extra_keys:
      category_name:
        description: |
          Pocket set topic name representing the just clicked category.
      selected_total:
        description: |
          How many categories were selected before this being tapped.
      new_state:
        description: |
          Category's new state after being tapped.
          Possible values: [selected], [deselected].
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21593
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21625#issuecomment-936745506
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-10-01"
  home_recs_discover_clicked:
    type: event
    description: |
      User tapped the "Discover more" tile to open a new tab
      for more Pocket stories.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21593
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21625#issuecomment-936745506
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-10-01"
  home_recs_learn_more_clicked:
    type: event
    description: |
      User tapped "Learn more" to open a new tab for Pocket.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21593
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21625#issuecomment-936745506
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-10-01"

first_session:
  campaign:
    type: string
    send_in_pings:
      - first-session
    description: |
      The name of the campaign that is responsible for this installation.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/7295
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8074#issuecomment-586512202
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance
  network:
    type: string
    send_in_pings:
      - first-session
    description: |
      The name of the Network that sourced this installation.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/7295
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8074#issuecomment-586512202
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance
  adgroup:
    type: string
    send_in_pings:
      - first-session
    description: |
      The name of the AdGroup that was used to source this installation.
    bugs:
      - https://github.com/mozilla-mobile/fenix/pull/8074#issuecomment-586512202
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8074#issuecomment-586480836
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Telemetry
  creative:
    send_in_pings:
      - first-session
    type: string
    description: |
      The identifier of the creative material that the user interacted with.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/7295
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8074#issuecomment-586512202
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance
  distribution_id:
    type: string
    description: |
      A string containing the distribution identifier. This is currently used
      to identify installs from Mozilla Online.
    send_in_pings:
      - first-session
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/20376
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22543#issuecomment-977456848
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
      - rxu@mozilla.com
    expires: never
  timestamp:
    send_in_pings:
      - first-session
    type: datetime
    description: |
      The Glean generated date and time of the installation. This is
      unique per app install, though the rest of the data in this
      ping is from Adjust and will remain static across installs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/7295
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8074#issuecomment-586512202
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance

browser.search:
  with_ads:
    type: labeled_counter
    description: |
      Records counts of SERP pages with adverts displayed.
      The key format is `<provider-name>`.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6558
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10112
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20230#issuecomment-879244938
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
  ad_clicks:
    type: labeled_counter
    description: |
      Records clicks of adverts on SERP pages.
      The key format is `<provider-name>`.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6558
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10112
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20230#issuecomment-879244938
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
  in_content:
    type: labeled_counter
    description: |
      Records the type of interaction a user has on SERP pages.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6557
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10167
      - https://github.com/mozilla-mobile/fenix/pull/15713#issuecomment-703972068
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20230#issuecomment-879244938
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never

addons:
  open_addons_in_settings:
    type: event
    description: |
      A user accessed "Add-ons" from the Settings
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6174
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8318
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-08-01"
    metadata:
      tags:
        - WebExtensions
  open_addon_in_toolbar_menu:
    type: event
    description: |
      A user interacted with an installed add-on in the toolbar menu
    extra_keys:
      addon_id:
        description: |
          The id of the add-on that was interacted with in the toolbar menu
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6174
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8318
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-08-01"
    metadata:
      tags:
        - WebExtensions
  open_addon_setting:
    type: event
    description: |
      A user opened an add-on's setting
    extra_keys:
      addon_id:
        description: |
          The id of the add-on that was interacted with
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/17644
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18504
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-08-01"
    metadata:
      tags:
        - WebExtensions
  has_installed_addons:
    type: boolean
    description: |
      Whether or not the user has installed add-ons on the device.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6174
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8318
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - WebExtensions
  has_enabled_addons:
    type: boolean
    description: |
      Whether or not the user has enabled add-ons on the device.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6174
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/8318
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - WebExtensions
  installed_addons:
    type: string_list
    description: |
      A list of all installed add-ons on the device.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/8920
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11080
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21788#issuecomment-950022224
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - WebExtensions
  enabled_addons:
    type: string_list
    description: |
      A list of all enabled add-ons on the device.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/8920
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11080
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
      - https://github.com/mozilla-mobile/fenix/pull/18143
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21316#issuecomment-944615938
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-08-01"

    metadata:
      tags:
        - WebExtensions
perf.startup:
  cold_main_app_to_first_frame:
    type: timing_distribution
    time_unit: millisecond
    description: |
      The duration from `*Application`'s initializer to the first Android frame
      being drawn in a [COLD MAIN start
      up](https://wiki.mozilla.org/index.php?title=Performance/Fenix/Glossary).
      Notably, this duration omits the time from process start to the
      initializer (which includes a lengthy dex operation) and the time from
      the first frame to visual completeness. This probe doesn't measure Custom
      Tabs or other uses of `ExternalAppBrowserActivity` to simplify result
      analysis. The methodology for determining this measurement is imperfect
      to simplify implementation. Issues may include:
      <br>- Not measuring Beta and Release channels (due to
      `MigrationDecisionActivity` interrupting the logic).
      <br>- Not distinguishing between MAIN to homescreen, onboarding, session
      restore, others?
      <br>- Not choosing to record a MAIN based on what the user would see and
      thus the core code path (i.e. the thing we want to measure) but rather on
      the initial `Intent` state.
      <br><br>
      The hope is that these cases will not have a significant impact on the end
      results but, if they appear to, we can replace it with a more complex
      implementation.
      <br><br>
      Around April 8, 2021 the implementation was refactored. Functionally, it
      should be the same but it's noted just in case there are bugs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18426
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18632#issue-600193452
      - https://github.com/mozilla-mobile/fenix/pull/20623#issue-701630599
      - https://github.com/mozilla-mobile/fenix/pull/23506
    data_sensitivity:
      - technical
    notification_emails:
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: never
  cold_view_app_to_first_frame:
    type: timing_distribution
    time_unit: millisecond
    description: |
      The duration from `*Application`'s initializer to the first Android frame
      being drawn in a [COLD VIEW start
      up](https://wiki.mozilla.org/index.php?title=Performance/Fenix/Glossary).
      The methodology for determining this measurement is imperfect to simplify
      implementation. Issues may include:
      <br>-Including VIEW intents that aren't valid so take code paths similar
      to MAIN (this is speculative)
      <br><br>
      See the `cold_main_app_to_first_frame` probe docs for other possible
      known issues and more details.
      <br><br>
      Around April 8, 2021 the implementation was refactored. Functionally, it
      should be the same but it's noted just in case there are bugs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18426
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18632#issue-600193452
      - https://github.com/mozilla-mobile/fenix/pull/20623#issue-701630599
      - https://github.com/mozilla-mobile/fenix/pull/23506
    data_sensitivity:
      - technical
    notification_emails:
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: never
  cold_unknwn_app_to_first_frame:
    type: timing_distribution
    time_unit: millisecond
    description: |
      The duration from `*Application`'s initializer to the first Android frame
      being drawn in a [COLD start
      up](https://wiki.mozilla.org/index.php?title=Performance/Fenix/Glossary)
      where we can't say it was a MAIN or VIEW start up. The methodology for
      determining this measurement is imperfect to simplify implementation.
      <br><br>
      See the `cold_main_app_to_first_frame` probe docs for known issues and
      more details.
      <br><br>
      Around April 8, 2021 the implementation was refactored. Functionally, it
      should be the same but it's noted just in case there are bugs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18426
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18632#issue-600193452
      - https://github.com/mozilla-mobile/fenix/pull/20623#issue-701630599
      - https://github.com/mozilla-mobile/fenix/pull/23506
    data_sensitivity:
      - technical
    notification_emails:
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: never
  application_on_create:
    type: timing_distribution
    time_unit: millisecond
    description: |
      The duration of `FenixApplication.onCreate` in the main process. This does
      not measure the duration of migration code (via
      `MigratingFenixApplication` included in the Beta and Release channels.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/17969
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/17973#issue-572183889
      - https://github.com/mozilla-mobile/fenix/pull/20623#issue-701630599
      - https://github.com/mozilla-mobile/fenix/pull/23506
    data_sensitivity:
      - technical
    notification_emails:
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: never
  startup_type:
    type: labeled_counter
    description: |
      Indicates how the browser was started. The label is divided into two
      variables. `state` is how cached the browser is when started. `path` is
      what code path we are expected to take. Together, they create a combined
      label: `state_path`. For brevity, the specific states are documented in
      the [Fenix perf
      glossary](https://wiki.mozilla.org/index.php?title=Performance/Fenix/Glossary).
      <br><br>
      This implementation is intended to be simple, not comprehensive. We list
      the implications below.

      <br><br>
      These ways of opening the app undesirably adds events to our primary
      buckets (non-`unknown` cases):
      <br>- App switcher cold/warm: `cold/warm_` + duplicates path from
      previous launch
      <br>- Home screen shortcuts: `*_view`
      <br>- An Intent is sent internally that's uses `ACTION_MAIN` or
      `ACTION_VIEW` could be: `*_main/view` (unknown if this ever happens)
      <br>- A command-line launch uses `ACTION_MAIN` or `ACTION_VIEW` could be:
      `*_main/view`

      <br><br>
      These ways of opening the app undesirably do not add their events to our
      primary buckets:
      <br>- Close and reopen the app very quickly: no event is recorded.

      <br><br>
      These ways of opening the app don't affect our primary buckets:
      <br>- App switcher hot: `hot_unknown`
      <br>- PWA (all states): `unknown_unknown`
      <br>- Custom tab: `unknown_view`
      <br>- Cold start where a service or other non-activity starts the process
      (not manually tested) - this seems to happen if you have the homescreen
      widget: `unknown_*`
      <br>- Another activity is drawn before HomeActivity (e.g. widget voice
      search): `unknown_*`
      <br>- Widget text search: `*_unknown`

      <br><br>
      In addition to the events above, the `unknown` state may be chosen when we
      were unable to determine a cause due to implementation details or the API
      was used incorrectly. We may be able to record the events listed above
      into different buckets but we kept the implementation simple for now.
      <br><br>
      N.B.: for implementation simplicity, we duplicate the logic in app that
      determines `path` so it's not perfectly accurate. In one way, we record we
      is intended to happen rather than what actually happened (e.g. the user
      may click a link so we record VIEW but the app does a MAIN by going to the
      homescreen because the link was invalid).
    labels:
      - cold_main
      - cold_view
      - cold_unknown
      - warm_main
      - warm_view
      - warm_unknown
      - hot_main
      - hot_view
      - hot_unknown
      - unknown_main
      - unknown_view
      - unknown_unknown
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18836
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/19028
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
    data_sensitivity:
      - interaction
    notification_emails:
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: "2022-04-01"

perf.awesomebar:
  history_suggestions:
    send_in_pings:
      - metrics
    type: timing_distribution
    time_unit: millisecond
    description: |
      Duration of a history awesomebar suggestion query.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/4992
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10276#pullrequestreview-411101979
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21315#issuecomment-920848442
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - gkruglov@mozilla.com
    expires: "2022-11-15"
  bookmark_suggestions:
    send_in_pings:
      - metrics
    type: timing_distribution
    time_unit: millisecond
    description: |
      Duration of a bookmarks awesomebar suggestion query.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/4992
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10276#pullrequestreview-411101979
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21315#issuecomment-920848442
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - gkruglov@mozilla.com
    expires: "2022-11-15"
  search_engine_suggestions:
    send_in_pings:
      - metrics
    type: timing_distribution
    time_unit: millisecond
    description: |
      Duration of a search engine awesomebar suggestion query.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/4992
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10276#pullrequestreview-411101979
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21315#issuecomment-920848442
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - gkruglov@mozilla.com
    expires: "2022-11-15"
  session_suggestions:
    send_in_pings:
      - metrics
    type: timing_distribution
    time_unit: millisecond
    description: |
      Duration of a session awesomebar suggestion query.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/4992
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10276#pullrequestreview-411101979
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21315#issuecomment-920848442
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - gkruglov@mozilla.com
    expires: "2022-11-15"
  synced_tabs_suggestions:
    send_in_pings:
      - metrics
    type: timing_distribution
    time_unit: millisecond
    description: |
      Duration of a synced tabs awesomebar suggestion query.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/4992
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10276#pullrequestreview-411101979
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21315#issuecomment-920848442
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - gkruglov@mozilla.com
    expires: "2022-11-15"
  clipboard_suggestions:
    send_in_pings:
      - metrics
    type: timing_distribution
    time_unit: millisecond
    description: |
      Duration of a clipboard awesomebar suggestion query.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/4992
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10276#pullrequestreview-411101979
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21315#issuecomment-920848442
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - gkruglov@mozilla.com
    expires: "2022-11-15"
  shortcuts_suggestions:
    send_in_pings:
      - metrics
    type: timing_distribution
    time_unit: millisecond
    description: |
      Duration of a shortcuts awesomebar suggestion query.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/4992
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10276#pullrequestreview-411101979
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21315#issuecomment-920848442
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - gkruglov@mozilla.com
    expires: "2022-11-15"

autoplay:
  visited_setting:
    type: event
    description: A user visited the autoplay settings screen
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11579
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/13041#issuecomment-665777411
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - SitePermissions
  setting_changed:
    type: event
    description: |
      A user changed their autoplay setting to either block_cellular,
      block_audio, or block_all.
    extra_keys:
      autoplay_setting:
        description: |
          The new setting for autoplay: block_cellular,
          block_audio, or block_all.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11579
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/13041#issuecomment-665777411
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - SitePermissions
storage.stats:
  query_stats_duration:
    send_in_pings:
      - metrics
    type: timing_distribution
    description: |
      How long it took to query the device for the StorageStats that contain the
      file size information. The docs say it may be expensive so we want to
      ensure it's not too expensive.  This value is only available on Android
      8+.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/12802
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12876#issuecomment-666770732
      - https://github.com/mozilla-mobile/fenix/pull/17704#issue-564299127
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20623#issue-701630599
      - https://github.com/mozilla-mobile/fenix/pull/23506
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: never
  app_bytes:
    send_in_pings:
      - metrics
    type: memory_distribution
    description: |
      The size of the app's APK and related files as installed: this is expected
      to be larger than download size. This is the output of
      [StorageStats.getAppBytes](https://developer.android.com/reference/android/app/usage/StorageStats#getAppBytes())
      so see that for details. This value is only available on Android 8+. A
      similar value may be available on the Google Play dashboard: we can use
      this value to see if that value is reliable enough.
    memory_unit: byte
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/12802
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12876#issuecomment-666770732
      - https://github.com/mozilla-mobile/fenix/pull/17704#issue-564299127
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20623#issue-701630599
      - https://github.com/mozilla-mobile/fenix/pull/23506
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: never
  cache_bytes:
    send_in_pings:
      - metrics
    type: memory_distribution
    description: |
      The size of all cached data in the app. This is the output of
      [StorageStats.getCacheBytes](https://developer.android.com/reference/android/app/usage/StorageStats#getCacheBytes())
      so see that for details. This value is only available on Android 8+.
    memory_unit: byte
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/12802
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12876#issuecomment-666770732
      - https://github.com/mozilla-mobile/fenix/pull/17704#issue-564299127
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20623#issue-701630599
      - https://github.com/mozilla-mobile/fenix/pull/23506
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: never
  data_dir_bytes:
    send_in_pings:
      - metrics
    type: memory_distribution
    description: |
      The size of all data minus `cache_bytes`. This is the output of
      [StorageStats.getDataBytes](https://developer.android.com/reference/android/app/usage/StorageStats#getDataBytes())
      except we subtract the value of `cache_bytes` so the cache is not measured
      redundantly; see that method for details. This value is only available on
      Android 8+.
    memory_unit: byte
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/12802
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12876#issuecomment-666770732
      - https://github.com/mozilla-mobile/fenix/pull/17704#issue-564299127
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20623#issue-701630599
      - https://github.com/mozilla-mobile/fenix/pull/23506
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - perf-android-fe@mozilla.com
      - mcomella@mozilla.com
    expires: never

progressive_web_app:
  homescreen_tap:
    type: event
    description: |
      A user taps on PWA homescreen icon
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10261
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11859
      - https://github.com/mozilla-mobile/fenix/pull/18071
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
      - https://github.com/mozilla-mobile/fenix/pull/23783#issuecomment-1041863879
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-03-31"
    metadata:
      tags:
        - PWA
  install_tap:
    type: event
    description: |
      A user installs a PWA. Could be a shortcut or added to homescreen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10261
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11859
      - https://github.com/mozilla-mobile/fenix/pull/18071
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
      - https://github.com/mozilla-mobile/fenix/pull/23783#issuecomment-1041863879
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-03-31"
    metadata:
      tags:
        - PWA

tabs:
  setting_opened:
    type: event
    description: |
      The tab settings were opened.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/15347#issue-707408975
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/15811#issuecomment-706402952
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs

contextual_menu:
  copy_tapped:
    type: event
    description: |
      The context menu's 'copy' option was used.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11580
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16968
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - ContextMenu
        - TextSelection
  search_tapped:
    type: event
    description: |
      The context menu's 'search' option was used.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11580
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16968
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - ContextMenu
        - TextSelection
  select_all_tapped:
    type: event
    description: |
      The context menu's 'select all' option was used.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11580
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16968
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - ContextMenu
        - TextSelection
  share_tapped:
    type: event
    description: |
      The context menu's 'share' option was used.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11580
      - https://github.com/mozilla-mobile/fenix/issues/19923
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/16968
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - ContextMenu
        - TextSelection

engine_tab:
  kills:
    type: labeled_counter
    labels:
      - foreground
      - background
    description: |
      How often was the content process of a foreground (selected) or
      background tab killed.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/9366
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/17864
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21779#issuecomment-938089467
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2022-07-01"
    metadata:
      tags:
        - Performance
  kill_foreground_age:
    type: timing_distribution
    time_unit: millisecond
    description: |
      Measures the age of the engine session of a foreground (selected) tab
      at the time its content process got killed.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/9366
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/17864
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21779#issuecomment-938089467
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2022-07-01"
    metadata:
      tags:
        - Performance
  kill_background_age:
    type: timing_distribution
    time_unit: millisecond
    description: |
      Measures the age of the engine session of a background tab at the
      time its content process got killed.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/9366
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/17864
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21779#issuecomment-938089467
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2022-07-01"
    metadata:
      tags:
        - Performance
  foreground_metrics:
    type: event
    description: |
      Event collecting data about the state of tabs when the app comes back to
      the foreground.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/9997
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18747#issuecomment-815731764
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21779#issuecomment-938089467
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2022-07-01"
    extra_keys:
      background_active_tabs:
        description: |
          Number of active tabs (with an engine session assigned) when the app
          went to the background.
      background_crashed_tabs:
        description: |
          Number of tabs marked as crashed when the app went to the background.
      background_total_tabs:
        description: |
          Number of total tabs when the app went to the background.
      foreground_active_tabs:
        description: |
          Number of active tabs (with an engine session assigned) when the
          app came back to the foreground.
      foreground_crashed_tabs:
        description: |
          Number of tabs marked as crashed when the app came back to the
          foreground.
      foreground_total_tabs:
        description: |
          Number of total tabs when the app came back to the foreground.
      time_in_background:
        description: |
          Time (in milliseconds) the app was in the background.
    metadata:
      tags:
        - Performance

synced_tabs:
  synced_tabs_suggestion_clicked:
    type: event
    description: |
      The synced tab suggestion in awesomebar was clicked.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18163
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18172
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
    metadata:
      tags:
        - SyncTabs

awesomebar:
  bookmark_suggestion_clicked:
    type: event
    description: |
      The bookmark suggestion in awesomebar was clicked.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18068
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18090
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  clipboard_suggestion_clicked:
    type: event
    description: |
      The clipboard suggestion in awesomebar was clicked.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18068
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18090
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  history_suggestion_clicked:
    type: event
    description: |
      The history suggestion in awesomebar was clicked.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18068
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18090
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  search_action_clicked:
    type: event
    description: |
      The search action in awesomebar was clicked.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18068
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18090
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  search_suggestion_clicked:
    type: event
    description: |
      The search suggestion in awesomebar was clicked.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18068
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18090
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  opened_tab_suggestion_clicked:
    type: event
    description: |
      The opened tab suggestion in awesomebar was clicked.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18068
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18090
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/20517#pullrequestreview-718069041
      - https://github.com/mozilla-mobile/fenix/pull/21038#issuecomment-906757301
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - erichards@mozilla.com
    expires: never

    metadata:
      tags:
        - Search
android_autofill:
  supported:
    type: boolean
    description: |
      Whether or not Android Autofill is supported by the device and is
      supported for this user.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/10301
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20547#issuecomment-889051503
      - https://github.com/mozilla-mobile/fenix/pull/22871#issuecomment-995092496
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2023-01-31"
  enabled:
    type: boolean
    description: |
      Whether or not Firefox is the Android Autofill provider for this user.
      provider.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/10301
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20547#issuecomment-889051503
      - https://github.com/mozilla-mobile/fenix/pull/22871#issuecomment-995092496
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2023-01-31"
  request_matching_logins:
    type: event
    description: |
      The app received an Android Autofill request from the system and was
      able to find matching logins for the request
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/10301
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20547#issuecomment-889051503
      - https://github.com/mozilla-mobile/fenix/pull/22871#issuecomment-995092496
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2023-01-31"
  request_no_matching_logins:
    type: event
    description: |
      The app received an Android Autofill request from the system and was
      not able to find matching logins for the request
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/10301
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20547#issuecomment-889051503
      - https://github.com/mozilla-mobile/fenix/pull/22871#issuecomment-995092496
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2023-01-31"
  search_displayed:
    type: event
    description: |
      The user has selected the search option to manually search a
      matching login
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/10301
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20547#issuecomment-889051503
      - https://github.com/mozilla-mobile/fenix/pull/22871#issuecomment-995092496
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2023-01-31"
  search_item_selected:
    type: event
    description: |
      The user has selected a search result for autofilling.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/10301
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20547#issuecomment-889051503
      - https://github.com/mozilla-mobile/fenix/pull/22871#issuecomment-995092496
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2023-01-31"
  unlock_cancelled:
    type: event
    description: |
      The user needed to unlock the app in order to autofill
      logins, but the process was cancelled.
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/10301
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20547#issuecomment-889051503
      - https://github.com/mozilla-mobile/fenix/pull/22871#issuecomment-995092496
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2023-01-31"
  unlock_successful:
    type: event
    description: |
      The user successfully unlock the app in order to autofill logins
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/10301
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20547#issuecomment-889051503
      - https://github.com/mozilla-mobile/fenix/pull/22871#issuecomment-995092496
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2023-01-31"
  confirm_cancelled:
    type: event
    description: |
      The user needed to confirm autofilling an unauthenticated
      application and decided to cancel
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/10301
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20547#issuecomment-889051503
      - https://github.com/mozilla-mobile/fenix/pull/22871#issuecomment-995092496
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2023-01-31"
  confirm_successful:
    type: event
    description: |
      The user confirmed autofilling an unauthenticated application
    bugs:
      - https://github.com/mozilla-mobile/android-components/issues/10301
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20547#issuecomment-889051503
      - https://github.com/mozilla-mobile/fenix/pull/22871#issuecomment-995092496
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - skaspari@mozilla.com
    expires: "2023-01-31"

home_menu:
  settings_item_clicked:
    type: event
    description: The user clicked the settings option in home menu.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18856
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18987
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
      - https://github.com/mozilla-mobile/fenix/pull/23786#issuecomment-1042331298
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-03-31"
    metadata:
      tags:
        - Settings
        - MainMenu

home_screen:
  home_screen_displayed:
    type: event
    description: The home screen was displayed.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18854
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/19025
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
      - https://github.com/mozilla-mobile/fenix/pull/23786#issuecomment-1042331298
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-03-31"
    metadata:
      tags:
        - HomeScreen
  home_screen_view_count:
    type: counter
    description: |
      The number of times the home screen was displayed to the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22146
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22377
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  customize_home_clicked:
    type: event
    description: A user clicked on Customize home from the home screen menu.
    bugs:
      - https://github.com/mozilla-mobile/fenix/pull/21344
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21344
      - https://github.com/mozilla-mobile/fenix/pull/21344#issuecomment-923198787
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-20"

android_keystore_experiment:
  experiment_failure:
    type: event
    description: |
      Records an instance of an unexpected failure during the experiment
    extra_keys:
      failure_exception:
        description: |
          Exception class associated with an unexpected failure of this
          experiment, not caught by the other failure handlers.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/17869
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18333#pullrequestreview-612447395
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-03-01"
  get_failure:
    type: event
    description: |
      Unexpected failure when trying to read from secure prefs.
    extra_keys:
      failure_exception:
        description: |
          Exception class associated with an unexpected failure of this
          experiment.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/17869
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18333#pullrequestreview-612447395
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-03-01"
  get_result:
    type: event
    description: |
      Success when trying to read from secure prefs.
    extra_keys:
      result:
        description: |
          Result code identifying whether the read operation returned the
          expected value or not.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/17869
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18333#pullrequestreview-612447395
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-03-01"
  write_failure:
    type: event
    description: |
      Unexpected failure when trying to write to secure prefs.
    extra_keys:
      failure_exception:
        description: |
          Exception class associated with an unexpected failure of this
          experiment.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/17869
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18333#pullrequestreview-612447395
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-03-01"
  write_success:
    type: event
    description: |
      Success in writing to secure prefs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/17869
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18333#pullrequestreview-612447395
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-03-01"
  reset:
    type: event
    description: |
      An experiment failed, and was reset to run again in the future from a
      blank state.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/17869
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/18333#pullrequestreview-612447395
      - https://github.com/mozilla-mobile/fenix/pull/19924#issuecomment-861423789
      - https://github.com/mozilla-mobile/fenix/pull/21076#issuecomment-909237275
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-03-01"

start_on_home:
  enter_home_screen:
    type: event
    description: |
      Know how often user lands on Homescreen upon opening the app.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19881
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/19885
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-06-16"
    metadata:
      tags:
        - HomeScreen
  open_tabs_tray:
    type: event
    description: |
      Know how often users open the tab tray.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19881
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/19885
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-06-16"
    metadata:
      tags:
        - HomeScreen
        - Tabs
recent_tabs:
  show_all_clicked:
    type: event
    description: |
      User has clicked show all button and opened tabs tray.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19955
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20138
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-06-23"
    metadata:
      tags:
        - RecentTabs
  recent_tab_opened:
    type: event
    description: |
      User has opened a recent tab from homescreen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19955
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20138
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-06-23"
    metadata:
      tags:
        - RecentTabs
  in_progress_media_tab_opened:
    type: event
    description: |
      User has opened a recent tab from homescreen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/20393
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20138
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-06-23"
    metadata:
      tags:
        - RecentTabs
  section_visible:
    type: boolean
    description: |
      An indication of whether the recent tabs /
      Jump Back In section is visible on the homepage.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22107
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22166
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"

recent_bookmarks:
  shown:
    type: event
    description: |
      Recent bookmarks section was shown to the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22103
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22104
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  bookmark_clicked:
    type: counter
    lifetime: application
    description: |
      A counter that indicates the number of times that a user
      has clicked on a recently saved bookmark from the home
      screen.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19931
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20316#issuecomment-888291843
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
  show_all_bookmarks:
    type: counter
    lifetime: application
    description: |
      A counter that indicates the number of times that a user
      has clicked the show all button for recently saved bookmarks
      on the home screen.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19931
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20316#issuecomment-888291843
      - https://github.com/mozilla-mobile/fenix/pull/23453#issuecomment-1024694220
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-02-01"
  recent_bookmarks_count:
    type: quantity
    description: |
      The number of bookmarked items appearing in the
      Recently Saved section on the home page.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22075
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22293
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
    unit: integer

recent_searches:
  group_deleted:
    type: event
    description: |
      A user has deleted a search term group from the
      "Recently visited" section on the homescreen using
      the long-press menu "Remove" option. This removes
      the item from the homescreen, but does not delete
      the item from history.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22175
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22176#issuecomment-956421788
      - https://github.com/mozilla-mobile/fenix/pull/23786#issuecomment-1042331298
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2023-03-31"

credit_cards:
  saved:
    type: counter
    description: |
      A counter of the number of credit cards that have been saved
      manually by the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-01"
    metadata:
      tags:
        - Autofill
  deleted:
    type: counter
    description: |
      A counter of the number of credit cards that have been deleted by
      the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-01"
    metadata:
      tags:
        - Autofill
  modified:
    type: event
    description: |
      A credit card has been modified by the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-01"
    metadata:
      tags:
        - Autofill
  form_detected:
    type: event
    description: |
      A credit card form was detected.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-01"
    metadata:
      tags:
        - Autofill
  autofilled:
    type: event
    description: |
      User has autofilled a credit card.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-01"
    metadata:
      tags:
        - Autofill
  autofill_prompt_shown:
    type: event
    description: |
      Credit card autofill prompt was shown.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-01"
    metadata:
      tags:
        - Autofill
  autofill_prompt_expanded:
    type: event
    description: |
      Credit card autofill prompt was expanded.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-01"
    metadata:
      tags:
        - Autofill
  autofill_prompt_dismissed:
    type: event
    description: |
      Credit card autofill prompt was dismissed.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-01"
    metadata:
      tags:
        - Autofill
  management_add_tapped:
    type: event
    description: |
      User has tapped the add button through credit card management settings.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-01"
    metadata:
      tags:
        - Autofill
  management_card_tapped:
    type: event
    description: |
      User has tapped on a saved card through credit card management settings.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-09-01"
    metadata:
      tags:
        - Autofill

search_terms:
  number_of_search_term_group:
    type: event
    description: |
      Number of search term group when tabs tray is opened.
    extra_keys:
      count:
        description: |
          The number of tabs per search group
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22057
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22058
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  average_tabs_per_group:
    type: event
    description: |
      Number of search term tabs per group when tabs tray is opened.
    extra_keys:
      count:
        description: |
          The average number of tabs per search group
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22057
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22058
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  jump_back_in_group_tapped:
    type: event
    description: |
      User tapped on the jump back in search term group.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22057
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22058
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-11-01"
  group_size_distribution:
    type: custom_distribution
    description: |
      The distribution of search term tab group sizes. Rather than reporting
      individual sizes directly as integers, it is currently desired to
      report the sizes according to certain size ranges.
      The "buckets" for reporting group sizes will be mapped as follows:
      * 2 tabs -> 1
      * 3-5 tabs -> 2
      * 6-10 tabs -> 3
      * 11+ tabs -> 4
      Where the reported number will be 1, 2, 3, or 4, accordingly.
      As an example, say a user has three groups of sizes 3, 6, and 15. The
      app will report 2, 3, and 4 when this metric is tracked.
    range_min: 1
    range_max: 4
    bucket_count: 5
    histogram_type: linear
    unit: tab_group_size_code
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/22410
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/22479
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: "2022-12-01"

wallpapers:
  wallpaper_settings_opened:
    type: event
    description: |
      User has opened the wallpaper settings screen.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23381
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23382
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: "2023-05-01"
  wallpaper_selected:
    type: event
    description: |
      A wallpaper is selected from the settings screen.
    extra_keys:
      name:
        description: The name of the selected wallpaper
        type: string
      theme_collection:
        description: The theme collection the selected wallpaper belongs to.
        type: string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23381
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23382
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: "2023-05-01"
  wallpaper_switched:
    type: event
    description: |
      The wallpaper was switched by using the homescreen toggle.
    extra_keys:
      name:
        description: The name of the new wallpaper
        type: string
      theme_collection:
        description: The theme collection the new wallpaper belongs to.
        type: string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23381
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23382
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: "2023-05-01"
  change_wallpaper_logo_toggled:
    type: event
    description: |
      A user has toggled the switch that controls the tap-logo-to-change-
      wallpaper feature.
    extra_keys:
      checked:
        description: Whether the switch is enabled or disabled.
        type: boolean
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23381
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23382
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: "2023-05-01"