# 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`
        type: string
    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
    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`)
        type: string
    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
    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
        type: boolean
    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
    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
        type: string
    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
    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, back_long_press,
          bookmark, bookmarks, desktop_view_off, desktop_view_on, downloads,
          find_in_page, forward, forward_long_press, history, new_tab, open_in_app, 
          open_in_fenix, quit, reader_mode_appearance, reload, remove_from_top_sites,
          save_to_collection, set_default_browser, settings, share, stop,
          sync_account, translate and print_content.
        type: string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1024
      - https://github.com/mozilla-mobile/fenix/issues/19923
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1808689
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836780
    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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1837517#c3
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
    expires: never
    metadata:
      tags:
        - Toolbar
  re_engagement_notif_tapped:
    type: event
    description: |
      User tapped on the re-engagement notification
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/27949
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27978
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  re_engagement_notif_shown:
    type: event
    description: |
      Re-engagement notification was shown to the user
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/27949
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27978
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  marketing_notification_allowed:
    type: boolean
    description: |
      True if marketing notifications are allowed, otherwise false.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/27795
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27797
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Notifications
  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
      - https://github.com/mozilla-mobile/fenix/pull/23802#issuecomment-1043255381
      - https://github.com/mozilla-mobile/fenix/pull/25405#issuecomment-1139058237
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - baseline
    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
    expires: never
    no_lint:
      - BASELINE_PING
    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.
        type: string
      enabled:
        description: "Whether or not the preference is *now* enabled"
        type: boolean
    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
    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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
        type: string
    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
    expires: never
    metadata:
      tags:
        - PrivateBrowsing
  opened_ext_pdf:
    type: event
    description: |
      A user opened a PDF with Fenix from another app
    extra_keys:
      referrer_is_fenix:
        description: |
          If the PDF was opened from Fenix itself (for example from the Download notification)
        type: boolean
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1871548
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4940
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - mcastelluccio@mozilla.com
      - calixte@mozilla.com
      - sylvestre@mozilla.com
    expires: never
  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
    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
    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
    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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  browser_toolbar_security_indicator_tapped:
    type: event
    description: |
      An event that indicates that a user has tapped
      the security indicator icon (at the start of the domain name).
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1869664
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/5019#issuecomment-1876329933
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Toolbar
  browser_toolbar_erase_tapped:
    type: event
    description: |
      An event that indicates that a user has tapped
      erase button on browser toolbar.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1859903
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4151#issuecomment-1769519433
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  browser_toolbar_input_cleared:
    type: event
    description: |
      A user pressed the circle cross icon, clearing the input in the toolbar.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1869664
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/5019#issuecomment-1876329933
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Toolbar
  browser_toolbar_qr_scan_tapped:
    type: event
    description: |
      An event that indicates that a user has tapped
      QR scan button on browser toolbar.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862096
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862096
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Toolbar
  browser_toolbar_qr_scan_completed:
    type: event
    description: |
      An event that indicates that a QR code has been scanned successfully.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1869664
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/5019#issuecomment-1876329933
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Toolbar
  toolbar_tab_swipe:
    type: event
    description: |
      A user swiped the toolbar to change the current tab.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862096
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862096
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Toolbar
  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.
        type: string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19956
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/19959#issuecomment-882539619
      - https://github.com/mozilla-mobile/fenix/pull/24409
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410276888
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  save_to_pdf_tapped:
    type: event
    description: |
      A user tapped the save to pdf option in the share sheet.
    extra_keys:
      source:
        type: string
        description: |
          A string that indicates the type of document of pdf, non-pdf or unknown.
          The default is unknown.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/3709
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1829213
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27257
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1829213#c4
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Sharing
  save_to_pdf_failure:
    type: event
    description: |
      A user tapped the save pdf but an error occurred
      and the process failed.
    extra_keys:
      source:
        type: string
        description: |
          A string that indicates the type of document of pdf, non-pdf or unknown.
          The default is unknown.
      reason:
        type: string
        description: |
          An error occurred while setting up for saving a PDF.
          Default option is unknown, other options are no_settings_service, no_settings,
          no_canonical_context, no_activity_context_delegate, no_activity_context,
          no_print_delegate, and io_error.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/27635
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1829213
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27661#issuecomment-1300505370
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1829213#c4
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Sharing
  save_to_pdf_completed:
    type: event
    description: |
      Saving to PDF successfully generated a PDF.
    extra_keys:
      source:
        type: string
        description: |
          A string that indicates the type of document of pdf, non-pdf or unknown.
          The default is unknown.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1829213
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1829213#c4
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Sharing
  print_failure:
    type: event
    description: |
      A user tapped the print in the menu or share sheet but an error occurred
      and the process failed.
    extra_keys:
      source:
        type: string
        description: |
          A string that indicates the type of document of pdf, non-pdf or unknown.
          The default is unknown.
      reason:
        type: string
        description: |
          An error occurred while setting up for printing.
          Default option is unknown, other options are no_settings_service, no_settings,
          no_canonical_context, no_activity_context_delegate, no_activity_context,
          no_print_delegate, and io_error.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1837517
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1837517#c3
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  print_completed:
    type: event
    description: |
      Printing from the share sheet or menu successfully completed.
    extra_keys:
      source:
        type: string
        description: |
          A string that indicates the type of document of pdf, non-pdf or unknown.
          The default is unknown.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1837517
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1837517#c3
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  print_tapped:
    type: event
    description: |
      A user tapped the print option in the menu or share sheet.
    extra_keys:
      source:
        type: string
        description: |
          A string that indicates the type of document of pdf, non-pdf or unknown.
          The default is unknown.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1837517
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1837517#c5
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  share_menu_action:
    type: event
    description: |
      A share 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
          currently include: print
        type: string
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1837517
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1837517#c5
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Sharing
  share_to_app:
    type: event
    description: |
      A user selected an app to share to from the share sheet.
    extra_keys:
      app_package:
        description: |
          Allowed package identifier for app or action (ex. 'org.mozilla.focus'
          or 'com.android.bluetooth') the user selected. Any package identifiers
          not in list are recorded as 'other'.

          Currently allowed packages are:
          'com.google.android.gm', 'com.microsoft.office.outlook',
          'com.samsung.android.email.provider', 'com.facebook.katana',
          'com.instagram.android', 'com.snapchat.android',
          'com.google.android.keep', 'com.samsung.android.app.notes',
          'com.microsoft.office.onenote', 'com.evernote',
          'com.google.android.apps.messaging', 'com.facebook.orca',
          'com.chating.messages.chat.fun', 'org.telegram.messenger',
          'org.thoughtcrime.securesms', 'com.google.android.apps.dynamite',
          'com.whatsapp', 'com.tencent.mm', 'com.Slack', 'com.discord',
          'com.android.bluetooth', 'com.google.android.gms',
          'org.mozilla.fenix.COPY_LINK_TO_CLIPBOARD
        type: string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/28033
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/28118#issuecomment-1341620815
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
    metadata:
      tags:
        - Sharing
  form_data_failure:
    type: event
    description: |
      Form data retrieval from a tab failed.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/28280
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/issues/28280#issuecomment-1376040252
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - technical
    expires: never
    metadata:
      tags:
        - Performance
  default_engine_selected:
    type: event
    description: |
      A user selected a new default search engine to use
    extra_keys:
      engine:
        type: string
        description: |
          The name of the default search engine the user selected as a string.
          Custom search engine user created will have the name `Custom`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1827686
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1674
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search

splash_screen:
  first_launch_extended:
    type: event
    description: |
      The splash screen was shown for an extended period of time, providing more time
      to download marketing and experiment data.
    extra_keys:
      data_fetched:
        type: boolean
        description: |
          If the splash screen was closed due to data being fetched or due to the time running out.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1840315
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2616
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never

onboarding:
  syn_cfr_shown:
    type: event
    description: |
      The Sync Onboarding CFR was shown to the user
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26489
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26507
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  sync_cfr_implicit_dismissal:
    type: event
    description: |
      The Sync Onboarding CFR was dismissed by the user by interacting
      with the outside of the popup.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26489
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26507
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  sync_cfr_explicit_dismissal:
    type: event
    description: |
      The Sync Onboarding CFR was dismissed by the user by clicking on
      the "X" button to close the popup.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26489
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26507
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - 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
    expires: never
    metadata:
      tags:
        - Onboarding
  welcome_card_impression:
    type: event
    description:
      The welcome onboarding card was displayed to the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26551
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26596
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  welcome_close_clicked:
    type: event
    description:
      The user clicked the `X` button from the welcome onboarding card.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26551
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26596
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  welcome_get_started_clicked:
    type: event
    description:
      The user clicked the `Get started` button from the welcome onboarding
      card.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26551
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26596
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  sync_card_impression:
    type: event
    description:
      The sync sign in onboarding card was displayed to the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26551
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26596
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  sync_close_clicked:
    type: event
    description:
      The user clicked the `X` button from the sync sign in onboarding card.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26551
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26596
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  sync_sign_in_clicked:
    type: event
    description:
      The user clicked the `Sign in` button from the sync sign in
      onboarding card.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26551
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26596
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  sync_skip_clicked:
    type: event
    description:
      The user clicked the `Skip` button from the sign in onboarding card.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26551
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26596
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  notif_ppp_impression:
    type: event
    description: |
      Notification pre permission prompt was shown to the user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1810115
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/28529
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Notifications
        - Onboarding
  notif_ppp_close_click:
    type: event
    description: |
      User clicked the close button on the notification pre permission prompt.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1810115
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/28529
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Notifications
        - Onboarding
  notif_ppp_positive_btn_click:
    type: event
    description: |
      User clicked the positive button on notification pre permission prompt.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1810115
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/28529
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Notifications
        - Onboarding
  notif_ppp_negative_btn_click:
    type: event
    description: |
      User clicked the negative button on notification pre permission prompt.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1810115
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/28529
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Notifications
        - Onboarding
  set_to_default_card:
    type: event
    description: |
      User viewed onboarding set to default card.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  sign_in_card:
    type: event
    description: |
      User viewed onboarding sign in card.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  turn_on_notifications_card:
    type: event
    description: |
      User viewed onboarding notification permission card.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  set_to_default:
    type: event
    description: |
      User tapped on set to default button in onboarding.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  skip_default:
    type: event
    description: |
      User tapped on skip set to default button in onboarding.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  sign_in:
    type: event
    description: |
      User tapped on sign in button in onboarding.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  skip_sign_in:
    type: event
    description: |
      User tapped on skip sign in button in onboarding.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  turn_on_notifications:
    type: event
    description: |
      User tapped on turn on notifications button in onboarding.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  skip_turn_on_notifications:
    type: event
    description: |
      User tapped on skip turn on notification button in onboarding.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  add_search_widget_card:
    type: event
    description: |
      User viewed onboarding add search widget card.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1848960
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3310
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  add_search_widget:
    type: event
    description: |
      User tapped on Add Firefox Widget in onboarding.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1848960
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3310
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  skip_add_search_widget:
    type: event
    description: |
      User tapped on skip add search widget button in onboarding.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1848960
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3310
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  privacy_policy:
    type: event
    description: |
      User tapped on privacy policy link in onboarding.
    extra_keys:
      element_type:
        type: string
        description: |
          Type of element that was viewed.
      action:
        type: string
        description: |
          Type of action taken by the user.
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Onboarding
  completed:
    type: event
    description: |
      User completed onboarding.
    extra_keys:
      sequence_position:
        type: string
        description: |
          Position of the onboarding card in the onboarding flow.
      sequence_id:
        type: string
        description: |
          Identifier for the sequence.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821726
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1554
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@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:
        type: string
        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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
        - Shortcuts

unified_search:
  search_menu_tapped:
    type: event
    description: |
      A user tapped on the unified search selector menu.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24522
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25544
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
        - Shortcuts
  engine_selected:
    type: event
    description: |
      A user used unified search to select a search shortcut engine to use
    extra_keys:
      engine:
        type: string
        description: |
          The name of the built-in search engine the user selected as a string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24522
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25544
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
        - Shortcuts

toolbar_settings:
  changed_position:
    type: event
    description: |
      The user selected a new position for the toolbar
    extra_keys:
      position:
        type: string
        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
    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
          ```
        type: string
    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
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    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
      - baseline
    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
    no_lint:
      - BASELINE_PING
    metadata:
      tags:
        - China
  bookmarks_add:
    type: labeled_counter
    lifetime: application
    description: |
      A counter that indicates how many bookmarks a user has added.

      The label for this counter is `<source>`.

      `source` will be: `page_action_menu` as that is the only
      entry point right now to add bookmarks.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836167
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2375
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  bookmarks_edit:
    type: labeled_counter
    lifetime: application
    description: |
      A counter that indicates how many bookmarks a user has edited.

      The label for this counter is `<source>`.

      `source` will be: `bookmark_edit_page` or `bookmark_panel`.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836167
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2375
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  bookmarks_delete:
    type: labeled_counter
    lifetime: application
    description: |
      A counter that indicates how many bookmarks a user has deleted.

      The label for this counter is `<source>`.

      `source` will be: `add_bookmark_toast` or `bookmark_panel`.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836167
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2375
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  bookmarks_open:
    type: labeled_counter
    lifetime: application
    description: |
      A counter that indicates how many bookmarks a user has opened.

      The label for this counter is `<source>`.

      `source` will be: `top_sites`, `awesomebar_results`, `bookmark_panel`.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836167
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2375
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  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-9067573./01
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@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
    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
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    expires: never
    metadata:
      tags:
        - Shortcuts
  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
    expires: never
    metadata:
      tags:
        - Shortcuts
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - baseline
    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
    expires: never
    no_lint:
      - BASELINE_PING
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Telemetry
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Discovery
        - Search
  private_tabs_open_count:
    type: counter
    lifetime: application
    description: |
      A counter that indicates how many PRIVATE 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 `private_tabs_open_count` ping and 0 open tabs,
      please see `has_open_tabs`
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836165
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2427
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
  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
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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-telemetry-alerts@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-telemetry-alerts@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
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    unit: integer
  default_wallpaper:
    type: boolean
    lifetime: application
    description: |
      Is the default wallpapper set to be shown?
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/25538
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25539#issuecomment-1163393066
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Wallpapers
  notifications_allowed:
    type: boolean
    description: |
      True if notifications are allowed, otherwise false.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/27795
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27797
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Notifications
  ram_more_than_threshold:
    type: boolean
    lifetime: application
    description: True if the device's asserted 'advertised' RAM is more than the given threshold.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1840341
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2620
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Experiments
  device_total_ram:
    type: quantity
    lifetime: application
    description: >
      The total amount of memory this device in bytes, when available will be
      MemoryInfo.advertisedMem otherwise it will be MemoryInfo.totalMem.
      This doesn't represent memory available to the application however.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1853967
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1853967#c3
      - https://github.com/mozilla-mobile/firefox-android/pull/3704
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    unit: integer
    metadata:
      tags:
        - Performance
  search_page_load_time:
    type: timing_distribution
    time_unit: millisecond
    lifetime: application
    description: The time that it takes to load the Search content.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1842604
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2889
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Experiments
  font_list_json:
    type: text
    lifetime: ping
    description: |
      A JSON blob representing the installed fonts
    send_in_pings:
      - font-list
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858193
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858193#c2
    data_sensitivity:
      # Text metrics are _required_ to be web_activity or highly_sensitive, so even though this
      # is more like 'technical' (per the Data Review), I'm marking highly sensitive.
      - highly_sensitive
    notification_emails:
      - android-probes@mozilla.com
      - tom@mozilla.com
    expires: 124

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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PocketIntegration
  sponsored_pocket:
    type: boolean
    description: |
      An indication of whether Pocket sponsored stories are enabled
      to be displayed
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/25401
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25418#issuecomment-1163390855
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PocketIntegration
  contile:
    type: boolean
    description: |
      An indication of whether Contile is enabled to be displayed
    send_in_pings:
      - metrics
      - topsites-impression
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24467
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/24468
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410642835
    data_sensitivity:
      - interaction
    lifetime: application
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  preference_toggled:
    type: event
    description: |
      A user toggles the preference for the home screen items.
    extra_keys:
      preference_key:
        type: string
        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, pocket, and contile.
      enabled:
        type: boolean
        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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - TrackingProtection
        - Settings
  etp_custom_cookies_selection:
    type: string
    description: |
      The option user has selected in the "Custom" mode of the
      Enhanced Tracking Protection settings.
      Possible values:
      - total-protection for “Isolate cross-site cookies”
      - social for “Cross-site and social media trackers”
      - unvisited for “Cookies from unvisited sites”
      - third-party for “All third-party cookies..”
      - all for “All cookies..”
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18175
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26449#issuecomment-1225765591
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    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
    expires: never
    metadata:
      tags:
        - Settings
  open_links_in_app_enabled:
    type: string
    description: |
      The user has the open links in apps feature enabled.
      "ask_before_opening", "always" or "never".
      default: "never"
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1818085
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1054
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@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
    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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

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
      - baseline
    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
    expires: never
    no_lint:
      - BASELINE_PING
  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
      - baseline
    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
    expires: never
    no_lint:
      - BASELINE_PING
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

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
      - https://github.com/mozilla-mobile/fenix/pull/25405#issuecomment-1139058237
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    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
    expires: never
    metadata:
      tags:
        - Bookmarks
  open_all_in_new_tabs:
    type: event
    description: |
      A user opened all the bookmarks in a folder in new tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11404
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27138
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@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
    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
    expires: never
    metadata:
      tags:
        - Bookmarks
  open_all_in_private_tabs:
    type: event
    description: |
      A user opened all the bookmarks in a folder in new private tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11404
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27138
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@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
    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
    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
    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
    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
    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
    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
    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
    expires: never
    metadata:
      tags:
        - Bookmarks
  search_icon_tapped:
    type: event
    description: |
      A user tapped on the search icon in bookmarks management.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/27147
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27268
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks
  search_result_tapped:
    type: event
    description: |
      A user tapped on the search result in bookmarks management.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/27147
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27268
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Bookmarks

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
    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
    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:
        type: string
        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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    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
    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
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - SendTab
  manage_account:
    type: event
    description: |
      A user pressed the "manage account" button on the account settings screen
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1846801
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5106
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Accounts
settings:
  sign_into_sync:
    type: counter
    description: |
      Counts the number of times a user has clicked "sign into sync" from the settings page.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836166
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2550
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Sync
        - Settings
  passwords:
    type: event
    description: |
      User has tapped Passwords in settings menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841152
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2802
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Settings
  autofill:
    type: event
    description: |
      User has tapped Autofill in settings menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841152
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2802
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Settings
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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - History
  removed_last_hour:
    type: event
    description: |
      A user removed history items opened during last hour.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26101
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26153
      - https://github.com/mozilla-mobile/firefox-android/pull/2225
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - History
  removed_today_and_yesterday:
    type: event
    description: |
      A user removed history items opened that day and the day before.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26101
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26153
      - https://github.com/mozilla-mobile/firefox-android/pull/2225
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - History
  remove_prompt_opened:
    type: event
    description: |
      A user opened delete history prompt.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26101
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26153
      - https://github.com/mozilla-mobile/firefox-android/pull/2225
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - History
  remove_prompt_cancelled:
    type: event
    description: |
      A user cancelled delete history prompt.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26101
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26153
      - https://github.com/mozilla-mobile/firefox-android/pull/2225
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - History
  opened_item:
    type: event
    description: |
      A user opened a history item
    extra_keys:
      is_remote:
        type: boolean
        description: |
          True if the history item is synced from other devices otherwise false.
      time_group:
        type: string
        description: |
          What time group does the history item belongs to.
          Possible values: [Today], [Yesterday], [ThisWeek], [ThisMonth],
          [Older].
      is_private:
        type: boolean
        description: |
          True if the history item is opened in a private tab, otherwise false.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18178
      - https://github.com/mozilla-mobile/fenix/issues/26502
    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
      - https://github.com/mozilla-mobile/fenix/pull/26503#issuecomment-1219761407
      - https://github.com/mozilla-mobile/fenix/pull/26863
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@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
    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
    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:
        type: string
        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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410276888
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410276888
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

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
    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
    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
    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
    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
    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
    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.
        type: string
    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
    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.
        type: string
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
      - https://github.com/mozilla-mobile/fenix/pull/25405#issuecomment-1139058237
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/25405#issuecomment-1139058237
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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.
        type: quantity
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/21903
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/21908
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  enter_multiselect_mode:
    type: event
    description: |
      User has entered multiselect mode.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23399
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23964#issuecomment-1051128057
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
    extra_keys:
      tab_selected:
        description: If a tab was selected when entering multi select.
        type: boolean
  share_selected_tabs:
    type: event
    description: |
      User has chosen to share selected tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23399
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23964#issuecomment-1051128057
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
    extra_keys:
      tab_count:
        description: The number of selected tabs shared.
        type: quantity
  bookmark_selected_tabs:
    type: event
    description: |
      User has chosen to bookmark selected tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23399
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23964#issuecomment-1051128057
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
    extra_keys:
      tab_count:
        description: The number of selected tabs bookmarked.
        type: quantity
  close_selected_tabs:
    type: event
    description: |
      User has chosen to close selected tabs.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23399
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23964#issuecomment-1051128057
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
    extra_keys:
      tab_count:
        description: The number of selected tabs closed.
        type: quantity
  selected_tabs_to_collection:
    type: event
    description: |
      User has chosen to save selected tabs to a collection.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23399
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23964#issuecomment-1051128057
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs
    extra_keys:
      tab_count:
        description: The number of selected tabs added to colelction.
        type: quantity
  access_point:
    type: labeled_counter
    description: |
      The area that the tabs tray was accessed from.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24549
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/24671
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never


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
    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
    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
    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
    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
    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
    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"
        type: string
      tabs_selected:
        description: "The number of tabs added to the collection"
        type: string
    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
    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
        type: string
      tabs_selected:
        description: The number of tabs added to the collection
        type: string
    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
    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
    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
    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
    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
    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`
        type: string
    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
    expires: never
    metadata:
      tags:
        - Collections
  placeholder_cancel:
    type: event
    description: |
      User interacted with the `X` button from the homescreen no collections
      placeholder.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821032
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1167
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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"
        type: string
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - TrackingProtection
  tcp_cfr_shown:
    type: event
    description: |
      The Total Cookie Protection CFR was shown to the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26224
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26226#issuecomment-1204007332
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - TrackingProtection
  tcp_cfr_implicit_dismissal:
    type: event
    description: |
      The Total Cookie Protection CFR was dismissed by the user by interacting
      with the outside of the popup.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26224
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26226#issuecomment-1204007332
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - TrackingProtection
  tcp_cfr_explicit_dismissal:
    type: event
    description: |
      The Total Cookie Protection CFR was dismissed by the user by clicking on
      the "X" button to close the popup.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26224
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26226#issuecomment-1204007332
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - TrackingProtection
  tcp_sumo_link_clicked:
    type: event
    description: |
      A user clicked the link in the Total Cookie Protection CFR to open a new
      SUMO tab detailing the Total Cookie Protection feature.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26224
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26226#issuecomment-1204007332
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Media

logins:
  password_detected:
    type: event
    description: |
      Password was detected for a website.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857549
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3978
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Logins
  autofill_prompt_shown:
    type: event
    description: |
      Password autofill prompt was shown.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841152
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2802
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Logins
  autofill_prompt_dismissed:
    type: event
    description: |
      Password autofill prompt was dismissed.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841152
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2802
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Logins
  autofilled:
    type: event
    description: |
      Password autofill performed.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841152
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2802
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Logins
  management_add_tapped:
    type: event
    description: |
      User has tapped the add button through password management in settings menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841152
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2802
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Logins
  management_logins_tapped:
    type: event
    description: |
      User has tapped on a saved login through password management in settings menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841152
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2802
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - 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
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Logins
  save_logins_setting_changed:
    type: event
    description: |
      A user changed their setting for asking to save logins
    extra_keys:
      setting:
        type: string
        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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Logins
  saved:
    type: counter
    description: |
      Counter of number of passwords that have been saved by user (including deleted).
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836164
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2555
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Logins
  saved_all:
    type: quantity
    description: |
      Counter of number of passwords currently saved by user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836164
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2555
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    unit: integer
    metadata:
      tags:
        - Logins
  deleted:
    type: counter
    description: |
      Counter of number of passwords that have been deleted by user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836164
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2555
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Logins
  modified:
    type: counter
    description: |
      Counter of number of passwords that have been modified by user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836164
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2555
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    expires: never
    metadata:
      tags:
        - Shortcuts
  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
    expires: never
    metadata:
      tags:
        - Search
        - Shortcuts
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
        - Shortcuts
  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
    expires: never
    metadata:
      tags:
        - Shortcuts
  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
    expires: never
    metadata:
      tags:
        - Shortcuts
  swipe_carousel:
    type: event
    description: |
      A user swiped to change the page of the top sites carousel
    extra_keys:
      page:
        type: string
        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
    expires: never
    metadata:
      tags:
        - Shortcuts
  long_press:
    type: event
    description: |
      A user long pressed on a top site
    extra_keys:
      type:
        type: string
        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
    expires: never
    metadata:
      tags:
        - Shortcuts
  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
    expires: never
    metadata:
      tags:
        - Shortcuts
  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
    expires: never
    metadata:
      tags:
        - Shortcuts
  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
    expires: never
    metadata:
      tags:
        - Shortcuts
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  context_id:
    type: uuid
    description: |
      A UUID that is unjoinable with other browser metrics. This ID will not be
      shared with AdM, only for internal uses. This ID is shared across all
      contextual services features.
    lifetime: application
    send_in_pings:
      - topsites-impression
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23893
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23945
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410663549
    data_sensitivity:
      - highly_sensitive
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shortcuts
  contile_tile_id:
    type: quantity
    description: |
      A unique identifier provided by the AdM for the sponsored TopSites tile
    lifetime: ping
    send_in_pings:
      - topsites-impression
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23893
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23945
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410663549
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    unit: integer
    metadata:
      tags:
        - Shortcuts
  contile_advertiser:
    type: string
    description: |
      Advertiser brand for the sponsored TopSites tile
    lifetime: ping
    send_in_pings:
      - topsites-impression
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23893
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23945
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410663549
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shortcuts
  contile_reporting_url:
    type: url
    description: |
      The AdM reporting endpoint (impression_url for “impression” event,
      click_url for “click” event).
    lifetime: ping
    send_in_pings:
      - topsites-impression
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23893
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23945
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410663549
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shortcuts
  contile_impression:
    type: event
    description: |
      A user saw a Contile top site
    extra_keys:
      source:
        description: The source of the event, example "newtab", "urlbar"
        type: string
      position:
        description: The tile placement (1-based)
        type: quantity
    send_in_pings:
      - topsites-impression
      - events
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23893
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23945
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410663549
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shortcuts
  contile_click:
    type: event
    description: |
      A user clicked a Contile top site
    extra_keys:
      source:
        description: The source of the event, example "newtab", "urlbar"
        type: string
      position:
        description: The tile placement (1-based)
        type: quantity
    send_in_pings:
      - topsites-impression
      - events
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23893
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23945
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410663549
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shortcuts
app_menu:
  customize_homepage:
    type: event
    description: |
      User has tapped on Customize Homepage in the app menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841156
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2726
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  sign_into_sync:
    type: counter
    description: |
      Counts the number of times a user has clicked "sign into sync" from the settings page.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836166
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2550
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Sync
        - Settings
app_theme:
  dark_theme_selected:
    type: event
    description: |
      A user selected Dark Theme
    extra_keys:
      source:
        type: string
        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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    expires: never
    no_lint:
      - COMMON_PREFIX
    metadata:
      tags:
        - PocketIntegration
        - Shortcuts
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PocketIntegration
        - Shortcuts
  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
      - https://github.com/mozilla-mobile/fenix/pull/26184#issuecomment-1194744884
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PocketIntegration
  home_recs_story_clicked:
    type: event
    description: |
      User tapped a Pocket recommended story to be opened.
    extra_keys:
      times_shown:
        type: string
        description: |
          How many times was this story shown, including current.
      position:
        type: string
        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
      - https://github.com/mozilla-mobile/fenix/pull/26184#issuecomment-1194744884
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PocketIntegration
  home_recs_spoc_clicked:
    type: event
    description: |
      User tapped a Pocket sponsored story to be opened.
    extra_keys:
      spoc_id:
        type: string
        description: |
          Id of the shown sponsored story.
          Until version 112 this will be the `flight_id` allowing to
          identify stories across different campaigns.
          From version 112 this will be the story `id` identifying a
          specific story irrespective of the campaign it is part of.
      times_shown:
        type: string
        description: |
          How many times was this story shown, including current.
      position:
        type: string
        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/25401
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1815160
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/28796#issuecomment-1422818844
      - https://github.com/mozilla-mobile/fenix/pull/25418#issuecomment-1163390855
      - https://github.com/mozilla-mobile/fenix/pull/26184#issuecomment-1194744884
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PocketIntegration
  spoc_shim:
    type: text
    description: |
      Shim data of the Pocket sponsored story the user just
      interacted with.
      The shim is a unique base64 string identifying each story and
      type of user interaction: story impression or click.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/27549
      - https://mozilla-hub.atlassian.net/browse/FNXV2-21791
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27550#issuecomment-1295027631
    data_sensitivity:
      - web_activity
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    send_in_pings:
      - spoc
    metadata:
      tags:
        - PocketIntegration
  home_recs_spoc_shown:
    type: event
    description: |
      A particular Pocket sponsored story was visible more than 50%
      on the homescreen.
    extra_keys:
      spoc_id:
        type: string
        description: |
          Id of the shown sponsored story.
          Until version 112 this will be the `flight_id` allowing to
          identify stories across different campaigns.
          From version 112 this will be the story `id` identifying a
          specific story irrespective of the campaign it is part of.
      times_shown:
        type: string
        description: |
          How many times was this story shown, including current.
      position:
        type: string
        description: |
          Position of the story in the list shown.
          Uses the [row x column] matrix notation.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/25401
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1815160
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/28796#issuecomment-1422818844
      - https://github.com/mozilla-mobile/fenix/pull/25418#issuecomment-1163390855
      - https://github.com/mozilla-mobile/fenix/pull/26184#issuecomment-1194744884
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PocketIntegration
  home_recs_category_clicked:
    type: event
    description: |
      User tapped a Pocket stories category to filter stories.
    extra_keys:
      category_name:
        type: string
        description: |
          Pocket set topic name representing the just clicked category.
      selected_total:
        type: string
        description: |
          How many categories were selected before this being tapped.
      new_state:
        type: string
        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
      - https://github.com/mozilla-mobile/fenix/pull/26184#issuecomment-1194744884
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PocketIntegration
  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
      - https://github.com/mozilla-mobile/fenix/pull/26184#issuecomment-1194744884
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PocketIntegration
  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
      - https://github.com/mozilla-mobile/fenix/pull/26184#issuecomment-1194744884
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PocketIntegration

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
    expires: never
    metadata:
      tags:
        - Performance
        - Attribution
  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
    expires: never
    metadata:
      tags:
        - Performance
        - Attribution
  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
    expires: never
    metadata:
      tags:
        - Telemetry
        - Attribution
  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
    expires: never
    metadata:
      tags:
        - Performance
        - Attribution
  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
    expires: never
    metadata:
      tags:
        - Performance
        - Attribution
  adjust_attribution_time:
    type: timing_distribution
    time_unit: millisecond
    send_in_pings:
      - first-session
      - metrics
    description: >
      The time that it takes to derive the attribution parameters by
      the Adjust SDK.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1823492
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1341#pullrequestreview-1354835757
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance
        - Attribution
  adjust_attribution_timespan:
    type: timespan
    time_unit: millisecond
    send_in_pings:
      - first-session
      - metrics
    description: >
      The time that it takes to derive the attribution parameters by
      the Adjust SDK.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1823492
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2974
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance
        - Attribution
play_store_attribution:
  install_referrer_response:
    type: text
    send_in_pings:
      - first-session
    description: |
      The full install referrer response.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862737
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4343
    data_sensitivity:
      # - technical
      - web_activity # This is a workaround so we can use Text type for technical data.
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
  source:
    type: string
    send_in_pings:
      - first-session
    description: |
      The name of the utm_source that is responsible for this installation.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832069
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1991#issuecomment-1545842578
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
  medium:
    type: string
    send_in_pings:
      - first-session
    description: |
      The name of the utm_medium that is responsible for this installation.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832069
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1991#issuecomment-1545842578
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
  campaign:
    type: string
    send_in_pings:
      - first-session
    description: |
      The name of the utm_campaign that is responsible for this installation.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832069
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1991#issuecomment-1545842578
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
  term:
    type: string
    send_in_pings:
      - first-session
    description: |
      The name of the utm_term that is responsible for this installation.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832069
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1991#issuecomment-1545842578
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
  content:
    type: string
    send_in_pings:
      - first-session
    description: |
      The name of the utm_content that is responsible for this installation.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832069
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1991#issuecomment-1545842578
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
  attribution_time:
    type: timing_distribution
    time_unit: millisecond
    send_in_pings:
      - metrics
    description: >
      The time that it takes to derive the attribution parameters by
      the Google Play Install Referrer library.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832069
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1991#issuecomment-1545842578
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
        - Performance
meta_attribution:
  app:
    type: string
    send_in_pings:
      - first-session
    description: |
      The mobile application ID in Meta's attribution.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1860133
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4171
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
  t:
    type: string
    send_in_pings:
      - first-session
    description: |
      Value tracking user interaction with Meta attribution.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1860133
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4171
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
  data:
    type: text
    send_in_pings:
      - first-session
    description: |
      The Meta attribution data in encrypted format.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1860133
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4171
    data_sensitivity:
      # - technical
      - web_activity # This is a workaround so we can use Text type for technical data.
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
  nonce:
    type: string
    send_in_pings:
      - first-session
    description: |
      Nonce used to decrypt the encrypted Meta attribution data.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1860133
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4171
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Attribution
browser.search:
  with_ads:
    type: labeled_counter
    description: |
      Records counts of SERP pages with adverts displayed.
      The key format is
      `<provider-name>.in-content.[sap|sap-follow-on|organic].[code|none](.[channel])?`,
      where:

      * `provider-name` is the name of the provider,
      * `sap|sap-follow-on|organic` is the search access point,
      * `code` is set when the url matches any of the provider's code prefixes,
      * `channel` is set to the url "channel" query parameter.
    send_in_pings:
      - metrics
      - baseline
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6558
      - https://github.com/mozilla-mobile/fenix/issues/28010
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1799049
    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
      - https://github.com/mozilla-mobile/fenix/pull/28012#issuecomment-1330822281
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    no_lint:
      - BASELINE_PING
  ad_clicks:
    type: labeled_counter
    description: |
      Records clicks of adverts on SERP pages.
      The key format is
      `<provider-name>.in-content.[sap|sap-follow-on|organic].[code|none](.[channel])?`,
      where:

      * `provider-name` is the name of the provider,
      * `sap|sap-follow-on|organic` is the search access point,
      * `code` is set when the url matches any of the provider's code prefixes,
      * `channel` is set to the url "channel" query parameter.
    send_in_pings:
      - metrics
      - baseline
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6558
      - https://github.com/mozilla-mobile/fenix/issues/28010
    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
      - https://github.com/mozilla-mobile/fenix/pull/28012#issuecomment-1330822281
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    no_lint:
      - BASELINE_PING
  in_content:
    type: labeled_counter
    description: |
      Records the type of interaction a user has on SERP pages.
    send_in_pings:
      - metrics
      - baseline
    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
    expires: never
    no_lint:
      - BASELINE_PING

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
      - https://github.com/mozilla-mobile/fenix/pull/25405#issuecomment-1139058237
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
        type: string
    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
      - https://github.com/mozilla-mobile/fenix/pull/25405#issuecomment-1139058237
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    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
    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
    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
      - https://github.com/mozilla-mobile/fenix/pull/25405#issuecomment-1139058237
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - WebExtensions
  extensions_process_ui_retry:
    type: counter
    lifetime: application
    description: |
      A counter that indicates the number of times that a user
      has clicked on the button try to restart add-ons
      on the dialog for when the extensions process crashed.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1850350
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1850350#c2
      - https://github.com/mozilla-mobile/firefox-android/pull/3472
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - wdurand@mozilla.com
      - amejiamarmol@mozilla.com
      - addons-dev-internal@mozilla.com
    expires: never
    metadata:
      tags:
        - WebExtensions
  extensions_process_ui_disable:
    type: counter
    lifetime: application
    description: |
      A counter that indicates the number of times that a user
      has clicked on the button continue with add-ons
      disabled on the dialog for when the extensions
      process crashed.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/19931
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1850350#c2
      - https://github.com/mozilla-mobile/firefox-android/pull/3472
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - wdurand@mozilla.com
      - amejiamarmol@mozilla.com
      - addons-dev-internal@mozilla.com
    expires: never
    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-telemetry-alerts@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-telemetry-alerts@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-telemetry-alerts@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-telemetry-alerts@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
      - https://github.com/mozilla-mobile/fenix/pull/23802#issuecomment-1043255381
    data_sensitivity:
      - interaction
    notification_emails:
      - perf-telemetry-alerts@mozilla.com
      - mleclair@mozilla.com
    expires: never

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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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, allow_all or block_all.
        type: string
    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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - SitePermissions

cookie_banners:
  setting_changed_pmb:
    type: event
    description: |
      A user changed their setting in private mode.
    extra_keys:
      cookie_banner_setting:
        description: |
          The new setting for cookie banners: disabled,reject_all,
          or reject_or_accept_all.
        type: string
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1796146
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27561
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security
  exception_added:
    type: event
    description: |
      A user added a cookie banner handling exception through
      the toggle in the protections panel.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1797577
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/28044#issuecomment-1334548056
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security
  exception_removed:
    type: event
    description: |
      A user removed a cookie banner handling
      exception through the toggle in the protections panel.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1797577
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/28044#issuecomment-1334548056
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security
  visited_panel:
    type: event
    description: A user visited the cookie banner toolbar panel
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1797577
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/28044#issuecomment-1334548056
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security
  report_site_domain:
    type: url
    description: |
      A user can report a site domain(Ex. for https://edition.cnn.com/
      site domain will be cnn.com) when the cookie banner reducer is not
      working from the cookie banner details panel.
    lifetime: ping
    send_in_pings:
      - cookie-banner-report-site
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805450
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1298#pullrequestreview-1350344223
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security
  report_site_cancel_button:
    type: event
    description: |
      The user has pressed the report site domain cancel button
      from the cookie banner reducer details panel.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805450
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1298#pullrequestreview-1350344223
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security
  report_domain_site_button:
    type: event
    description: |
      The user has pressed the report site domain button
      from the cookie banner reducer details panel.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805450
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1298#pullrequestreview-1350344223
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security
  cfr_shown:
    type: event
    description: The cookie banner cfr has been shown
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1859393
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1859393#c2
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security
  cfr_dismissal:
    type: event
    description: |
      The cookie banners CFR was dismissed by the user by interacting
      with the outside of the popup
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1859393
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1859393#c2
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security
site_permissions:
  prompt_shown:
    type: event
    description: |
      A prompt for the user to approve site permissions is shown.
    extra_keys:
      permissions:
        description: |
          Comma delimited list of permissions to approve.
        type: string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/25658
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25664#issuecomment-1159151213
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - SitePermissions
  permissions_allowed:
    type: event
    description: |
      User approved site permissions.
    extra_keys:
      permissions:
        description: |
          Comma delimited list of approved permissions.
        type: string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/25658
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25664#issuecomment-1159151213
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - SitePermissions
  permissions_denied:
    type: event
    description: |
      User denied site permissions.
    extra_keys:
      permissions:
        description: |
          Comma delimited list of approved permissions.
        type: string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/25658
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25664#issuecomment-1159151213
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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-telemetry-alerts@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-telemetry-alerts@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-telemetry-alerts@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-telemetry-alerts@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
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410276888
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410276888
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - PWA
  onboarding_cancel:
    type: event
    description: |
      User interacts with the onboarding PWA dialog cancel button which takes
      them to the website.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821030
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1164
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    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
    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
    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
    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
    expires: never
    metadata:
      tags:
        - ContextMenu
        - TextSelection

engine_tab:
  tab_killed:
    type: event
    description: |
      A tab was killed by the engine to free memory.
    extra_keys:
      foreground_tab:
        description: |
          Whether or not the tab was the currently active tab.
        type: boolean
      app_foreground:
        description: |
          Whether or not the app was in the foreground when the tab was killed.
        type: boolean
      had_form_data:
        description: |
          Whether or not the tab had unsubmitted form data when it was killed.
        type: boolean
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1820211
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1343#issuecomment-1478535296
    notification_emails:
      - android-probes@mozilla.com
    expires: never

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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
    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
    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
    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
    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
    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
    expires: never
    metadata:
      tags:
        - Search
  search_term_suggestion_clicked:
    type: event
    description: |
      The search term suggestion in awesomebar was clicked.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/25816
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27810#issuecomment-1380720028
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  sponsored_suggestion_clicked:
    type: event
    description: |
      A sponsored suggestion in the awesomebar was clicked.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1871156
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4914#issuecomment-1874271848
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    extra_keys:
      provider: &sponsored_suggestion_provider
        description: |
          The provider of the sponsored suggestion. Possible values: `amp` (for adMarketplace
          suggestions).
        type: string
    metadata:
      tags:
        - Search
  non_sponsored_suggestion_clicked:
    type: event
    description: |
      A non-sponsored suggestion in the awesomebar was clicked.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1871156
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4914#issuecomment-1874271848
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    extra_keys:
      provider: &non_sponsored_suggestion_provider
        description: |
          The provider of the non-sponsored suggestion. Possible values: `wikipedia`.
        type: string
    metadata:
      tags:
        - Search
  sponsored_suggestion_impressed:
    type: event
    description: |
      A sponsored suggestion was visible when the user finished interacting with the awesomebar.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1871156
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4914#issuecomment-1874271848
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    extra_keys:
      provider: *sponsored_suggestion_provider
      engagement_abandoned: &awesomebar_engagement_abandoned
        description: |
          If `true`, the user dismissed the awesomebar without navigating to a destination. If
          `false`, the user finished engaging with the awesomebar by navigating to a destination,
          like a URL, a search results page, or a suggestion.
        type: boolean
    metadata:
      tags:
        - Search
  non_sponsored_suggestion_impressed:
    type: event
    description: |
      A non-sponsored suggestion was visible when the user finished interacting with the awesomebar.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1871156
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4914#issuecomment-1874271848
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    extra_keys:
      provider: *non_sponsored_suggestion_provider
      engagement_abandoned: *awesomebar_engagement_abandoned
    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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27295
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

home_menu:
  help_tapped:
    type: event
    description: The user clicked the help button in home menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858771
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4066
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Settings
        - MainMenu
  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
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410675626
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410681521
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - HomeScreen
  standard_homepage_view_count:
    type: counter
    description: |
      The number of times the standard browsing mode home screen was
      displayed to the user. (for tile counts)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1842082
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2841
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

homepage:
  private_mode_icon_tapped:
    type: event
    description: |
      A user tapped the private browsing icon on the homepage.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841153
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2725
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs

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
      - https://github.com/mozilla-mobile/fenix/pull/24982
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/24982
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/24982
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/24982
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  jump_back_in_cfr_shown:
    type: event
    description: |
      Jump back in CFR has been displayed to the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26191
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26202
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  jump_back_in_cfr_dismissed:
    type: event
    description: |
      Jump back in CFR has been dismissed clicking the X button.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26191
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26202
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  jump_back_in_cfr_cancelled:
    type: event
    description: |
      Jump back in CFR has been cancelled clicking the outside the CFR.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26191
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26202
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/28502
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  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
      - https://github.com/mozilla-mobile/fenix/pull/27068#issuecomment-1251509973
      - https://github.com/mozilla-mobile/firefox-android/pull/3319
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/28709#issuecomment-1410276888
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  saved_all:
    type: quantity
    description: |
      Counter of number of credit cards that are currently stored by user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836164
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2555
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    unit: integer
    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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    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
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  save_prompt_create:
    type: event
    description: |
      User saved a credit card using the autofill save prompt.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/25397
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25411
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  save_prompt_update:
    type: event
    description: |
      User updated a credit card using the autofill save prompt.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/25397
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25411
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  save_prompt_shown:
    type: event
    description: |
      The credit card autofill save prompt is shown.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26089
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26095
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill

addresses:
  saved:
    type: counter
    description: |
      A counter of the number of addresses that have been saved
      manually by the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24857
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25216
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  saved_all:
    type: quantity
    description: |
      A counter of the number of all addresses that are currently saved by user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836164
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2555
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    unit: integer
    metadata:
      tags:
        - Autofill
  updated:
    type: counter
    description: |
      A counter of the number of addresses that have been updated
      manually by the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24857
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25216
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  deleted:
    type: counter
    description: |
      A counter of the number of addresses that have been deleted by
      the user.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24857
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25216
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  form_detected:
    type: event
    description: |
      A address form was detected.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25216
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  autofilled:
    type: event
    description: |
      User has autofilled an address.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/18711
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25216
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  autofill_prompt_shown:
    type: event
    description: |
      Address autofill prompt was shown.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24857
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25216
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  autofill_prompt_expanded:
    type: event
    description: |
      Address autofill prompt was expanded.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24857
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25216
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  autofill_prompt_dismissed:
    type: event
    description: |
      Address autofill prompt was dismissed.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24857
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25216
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  management_add_tapped:
    type: event
    description: |
      User has tapped the add button through address management settings.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24857
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/20909
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill
  management_address_tapped:
    type: event
    description: |
      User has tapped on a saved address through address management settings.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24857
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/25216
      - https://github.com/mozilla-mobile/fenix/pull/26123#issuecomment-1190794469
      - https://github.com/mozilla-mobile/firefox-android/pull/2597
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Autofill

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
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
    no_lint:
      - COMMON_PREFIX
    metadata:
      tags:
        - Wallpapers
  wallpaper_selected:
    type: event
    description: |
      A wallpaper is selected from the settings screen or onboarding dialog.
    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
      source:
        description: |
          A string that tells us how the user selected the wallpaper.
          Possible values are: `settings`, `onboarding`
        type: string
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23381
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23382
      - https://github.com/mozilla-mobile/fenix/pull/26893
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
    no_lint:
      - COMMON_PREFIX
    metadata:
      tags:
        - Wallpapers
  onboarding_opened:
    type: event
    description: |
      The wallpaper onboarding dialog has been displayed.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26215
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26893
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
    metadata:
      tags:
        - Wallpapers
  onboarding_closed:
    type: event
    description: |
      The wallpaper onboarding dialog has been closed.
    extra_keys:
      is_selected:
        description: Whether or not a wallpaper has been selected.
        type: boolean
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26215
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26893
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
    metadata:
      tags:
        - Wallpapers
  onboarding_explore_more_click:
    type: event
    description: |
      The wallpaper onboarding learn more button was clicked.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/26215
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26893
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
    metadata:
      tags:
        - Wallpapers
  learn_more_link_click:
    type: event
    description: |
      The learn more link for a wallpaper collection has been clicked.
    extra_keys:
      collection_name:
        description: The name of the wallpaper collection the link leads to.
        type: string
      url:
        description: The URL associated with the wallpaper collection.
        type: string
    bugs:
      - https://github:com/mozilla-mobile/fenix/issues/26945
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/26990
      - https://github.com/mozilla-mobile/firefox-android/pull/1875
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
    metadata:
      tags:
        - Wallpapers

recently_visited_homepage:
  history_highlight_opened:
    type: event
    description: |
      User has opened any history highlight from homepage
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23821
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23909
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
  search_group_opened:
    type: event
    description: |
      User has opened a search group from homepage
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/23821
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/23909
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never

recent_synced_tabs:
  recent_synced_tab_shown:
    type: labeled_counter
    description: |
      Counts impressions of a recent synced tab on the homepage, labeled by the
      device type the tab originates from.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24549
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/24671
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
  recent_synced_tab_time_to_load:
    type: timing_distribution
    time_unit: millisecond
    description: |
      Measures the amount of time between the beginning of a sync and the end.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24549
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/24671
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  recent_synced_tab_opened:
    type: labeled_counter
    description: |
      Counts the number of times a recent synced tab is opened, labeled by the
      device type the tab originates from.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24549
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/24671
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
  show_all_synced_tabs_clicked:
    type: counter
    description: |
      Counts how many times "show all synced tabs" button has been clicked.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24549
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/24671
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
  latest_synced_tab_is_stale:
    type: counter
    description: |
      Counts how often the loading placeholder is shown and the resulting tab
      is the same as it was before the load.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/24549
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/24671
      - https://github.com/mozilla-mobile/firefox-android/pull/1101
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never
review_prompt:
  prompt_attempt:
    type: event
    description: |
      Data captured for each attempt to display the review prompt.
    extra_keys:
      prompt_was_displayed:
        description: |
          Whether the prompt was displayed to the user. Value
          reported will be: 'true', 'false' or 'error'.
        type: string
      local_datetime:
        description: |
          The local datetime.
        type: string
      number_of_app_launches:
        description: |
          The total number of times the app has been launched.
        type: quantity
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/27472
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/27596
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    data_sensitivity:
      - interaction
    expires: never

private_browsing_shortcut_cfr:
  add_shortcut:
    type: event
    description: |
      Pivate browsing CFR "Add shortcut" button pressed.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4658
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1819909
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1139
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  cancel:
    type: event
    description: |
      Pivate browsing CFR "No thanks" button pressed.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4658
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1819909
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1139
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    notification_emails:
      - android-probes@mozilla.com
    expires: never

pull_to_refresh_in_browser:
  enabled:
    type: boolean
    description: |
      Whether or not pull-to-refresh functionality
      is enabled from Settings screen.
      default: true
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825413
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1775#pullrequestreview-1401966483
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Settings
  executed:
    type: event
    description: |
      Whether the pull-to-refresh gesture was executed by the user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1825413
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/1775#pullrequestreview-1401966483
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

app_icon:
  new_private_tab_tapped:
    type: event
    description: |
      A user tapped to open new private tab in Firefox Android app shortcuts menu.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841153
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2725
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Tabs

sync:
  failed:
    type: event
    description: |
      User sign-in/sync has failed.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841156
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/2726
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

shopping:
  address_bar_icon_displayed:
    type: event
    description: |
      The shopping icon was displayed in the address bar.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  address_bar_icon_clicked:
    type: event
    description: |
      The shopping icon from the address bar was clicked.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  address_bar_feature_callout_displayed:
    type: event
    description: |
      The shopping CFR was displayed to the user.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_closed:
    type: event
    description: |
      The shopping bottom sheet was closed.
    extra_keys:
      source:
        description: |
          The method used to close the bottom sheet. Possible values are: `sheet_slide`,
          `link_opened`, `click_outside`, `back_pressed`, `handle_clicked`, `not_now` 
          or `opt_out`.
        type: string
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1855150
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4060
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_displayed:
    type: event
    description: |
      The shopping bottom sheet was displayed.
    extra_keys:
      view:
        description: |
          State of the bottom sheet. Possible values are: `half` or `full`.
        type: string
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1855150
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
      - https://github.com/mozilla-mobile/firefox-android/pull/4060
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_onboarding_displayed:
    type: event
    description: |
      The shopping contextual onboarding card was displayed.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_review_quality_explainer_url_clicked:
    type: event
    description: |
      User interacted with the learn more link from the shopping explanation card.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_show_terms_clicked:
    type: event
    description: |
      User interacted with the terms and conditions link from the shopping contextual onboarding card.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_show_privacy_policy_clicked:
    type: event
    description: |
      User interacted with the privacy policy link from the shopping contextual onboarding card.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_not_now_clicked:
    type: event
    description: |
      User interacted with the opt out button from the shopping contextual onboarding card.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_opt_in_accepted:
    type: event
    description: |
      User interacted with the opt in button from the shopping contextual onboarding card.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_show_more_recent_reviews_clicked:
    type: event
    description: |
      User interacted with the expand "show more" button from the shopping highlights card.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_learn_more_clicked:
    type: event
    description: |
      The user clicked on learn more link from the onboarding card.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_expand_settings:
    type: event
    description: |
      Settings card from the bottom sheet was expanded.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_no_review_reliability_available:
    type: event
    description: |
      No analysis card was displayed to the user.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_analyze_reviews_none_available_clicked:
    type: event
    description: |
      User clicked on the launch analyzer link from the no analysis card.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_reanalyze_clicked:
    type: event
    description: |
      User interacted with the launch analyzer link from the "New info to check" warning card.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_reactivated_button_clicked:
    type: event
    description: |
      User interacted with the button to report a product is back in stock.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  product_page_visits:
    type: counter
    description: |
      Counts number of visits to a supported retailer product page
      while enrolled in either the control or treatment branches
      of the shopping experiment.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854501
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4120#issuecomment-1768423370
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_powered_by_fakespot_link_clicked:
    type: event
    description: |
      The user clicked the "Fakespot by Mozilla" link at the bottom of review checker
      sheet.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862775
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4354#issuecomment-1794341141
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_stale_analysis_shown:
    type: event
    description: |
      Records an event when the "New info to check" card is shown.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862776
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4379#issuecomment-1794925138
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_ads_impression:
    type: event
    description: |
      The user viewed an ad in review checker for at least 1.5 seconds.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1865854
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4604#issuecomment-1827890623
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_ads_clicked:
    type: event
    description: |
      The user clicked an ad in review checker.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1865854
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4604#issuecomment-1827890623
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_ads_setting_toggled:
    type: event
    description: |
      The user toggled the ads display setting.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1865854
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4604#issuecomment-1827890623
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    extra_keys:
      action:
        type: string
        description: |
          Whether the toggle was used to enable or disable ads. Possible values
          are `enabled` and `disabled`.
    metadata:
      tags:
        - Shopping
  ads_exposure:
    type: event
    description: |
      On a supported product page, the review checker showed analysis,
      and the ads exposure pref was enabled, or review checker ads were enabled,
      and when we tried to fetch an ad from the ad server, an ad was available.
      Does not indicate whether the ad was actually shown.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1866992
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4622#issuecomment-1829905076
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  surface_no_ads_available:
    type: event
    description: |
      On a supported product page, the review checker
      showed analysis, and review checker ads were enabled,
      but when we tried to fetch an ad from the ad server,
      no ad was available.
    send_in_pings:
      - events
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1866992
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4622#issuecomment-1829905076
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
       tags:
        - Shopping

shopping.settings:
  component_opted_out:
    type: boolean
    description: |
      Whether or not the user opted out of review quality check feature.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  nimbus_disabled_shopping:
    type: boolean
    description: |
      Whether or not Nimbus has disabled the use of the shopping component.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  user_has_onboarded:
    type: boolean
    description: |
      Whether or the user has completed the review quality check onboarding.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1843508
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3619
      - https://github.com/mozilla-mobile/firefox-android/pull/4039
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
  disabled_ads:
    type: boolean
    description: |
      Indicates if the user has disabled ads.
    send_in_pings:
      - metrics
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1865854
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4604#issuecomment-1827890623
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Shopping
fx_suggest:
  ping_type:
    type: string
    description: >
      The ping's type. Either "fxsuggest-click" or "fxsuggest-impression".
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857092
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3958#issuecomment-1768996728
      - https://github.com/mozilla-mobile/firefox-android/pull/4146#issuecomment-1775955811
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - fx-suggest
  position:
    type: quantity
    unit: non-negative integer
    description: >
      The position (1-based) of this suggestion in the full list of suggestions, relative to the
      top of the awesomebar.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858542
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4146#issuecomment-1775955811
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - fx-suggest
  block_id:
    type: quantity
    description: |
      A unique identifier for a sponsored suggestion. Not set for non-sponsored suggestions.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857092
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3958#issuecomment-1768996728
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    unit: integer
    send_in_pings:
      - fx-suggest
  advertiser:
    type: string
    description: |
      The name of the advertiser providing the sponsored suggestion
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857092
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3958#issuecomment-1768996728
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - fx-suggest
  is_clicked:
    type: boolean
    description: >
      If `ping_type` is "fxsuggest-impression", indicates whether this impression is for a clicked
      suggestion. If `ping_type` is "fxsuggest-click", always `true`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858542
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/4146#issuecomment-1775955811
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - fx-suggest
  reporting_url:
    type: url
    description: |
      If this ping is for a sponsored suggestion, the partner URL for reporting this interaction.
      Not set for non-sponsored suggestions.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857092
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3958#issuecomment-1768996728
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - fx-suggest
  context_id:
    type: uuid
    description: |
      An identifier to identify users for Contextual Services user interaction pings.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857092
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3958#issuecomment-1768996728
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - fx-suggest
  iab_category:
    type: string
    description: |
      The suggestion's advertising category. "22 - Shopping" for sponsored suggestions.
      Not set for non-sponsored suggestions.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857092
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/3958#issuecomment-1768996728
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - lina@mozilla.com
      - ttran@mozilla.com
      - najiang@mozilla.com
    expires: never
    send_in_pings:
      - fx-suggest
