tor-browser

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

metrics.yaml (117298B)


      1 # This Source Code Form is subject to the terms of the Mozilla Public
      2 # License, v. 2.0. If a copy of the MPL was not distributed with this
      3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
      4 
      5 # Adding a new metric? We have docs for that!
      6 # https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
      7 
      8 ---
      9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
     10 $tags:
     11  - 'Firefox :: New Tab Page'
     12 
     13 newtab:
     14  locale:
     15    type: string
     16    description: >
     17      The application's locale as of when newtab's TelemetryFeed was init.
     18      Comes from `Services.local.appLocaleAsBCP47`.
     19      Looks like `en-US`.
     20    bugs:
     21      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
     22      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
     23      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
     24    data_reviews:
     25      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
     26      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
     27      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
     28    data_sensitivity:
     29      - interaction
     30    notification_emails:
     31      - anicholson@mozilla.com
     32      - chutten@mozilla.com
     33      - mmccorquodale@mozilla.com
     34      - najiang@mozilla.com
     35      - lina@mozilla.com
     36    expires: never
     37    send_in_pings:
     38      - newtab
     39    lifetime: application
     40 
     41  newtab_category:
     42    type: string
     43    description: >
     44      The current setting of the newtab page.
     45      One of ["enabled", "disabled", "extension"] or any value from
     46      SiteClassifier like "known-hijacker" or "social-media".
     47      Similar to Activity Stream's PAGE_TAKEOVER_DATA event's
     48      `newtab_url_category`.
     49      Sampled once after newtab init.
     50    bugs:
     51      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
     52      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
     53    data_reviews:
     54      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
     55      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
     56    data_sensitivity:
     57      - technical
     58    notification_emails:
     59      - anicholson@mozilla.com
     60      - chutten@mozilla.com
     61      - mmccorquodale@mozilla.com
     62      - najiang@mozilla.com
     63      - lina@mozilla.com
     64    expires: never
     65    send_in_pings:
     66      - newtab
     67    lifetime: application
     68 
     69  homepage_category:
     70    type: string
     71    description: >
     72      The current setting of the home page.
     73      One of ["enabled", "disabled", "extension"] or any value from
     74      SiteClassifier like "known-hijacker" or "social-media".
     75      Similar to Activity Stream's PAGE_TAKEOVER_DATA event's
     76      `home_url_category`.
     77      Sampled once after newtab init.
     78    bugs:
     79      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
     80      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
     81    data_reviews:
     82      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
     83      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
     84    data_sensitivity:
     85      - technical
     86    notification_emails:
     87      - anicholson@mozilla.com
     88      - chutten@mozilla.com
     89      - mmccorquodale@mozilla.com
     90      - najiang@mozilla.com
     91      - lina@mozilla.com
     92    expires: never
     93    send_in_pings:
     94      - newtab
     95    lifetime: application
     96 
     97  opened:
     98    type: event
     99    description: >
    100      Recorded when newtab UI is opened via `about:newtab` or `about:home` or
    101      `about:welcome` and has been made visible (see `visibility_event_rcvd_ts`
    102      in
    103      [detect-user-session-start.js](https://searchfox.org/mozilla-central/source/browser/components/newtab/content-src/lib/detect-user-session-start.js)).
    104    bugs:
    105      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
    106      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
    107      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    108    data_reviews:
    109      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
    110      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
    111      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    112    data_sensitivity:
    113      - interaction
    114    notification_emails:
    115      - anicholson@mozilla.com
    116      - chutten@mozilla.com
    117      - mmccorquodale@mozilla.com
    118      - najiang@mozilla.com
    119      - lina@mozilla.com
    120    expires: never
    121    extra_keys:
    122      newtab_visit_id: &newtab_visit_id
    123        description: >
    124          The id of this newtab visit.
    125          Allows you to separate multiple simultaneous newtabs and
    126          build an event timeline of actions taken from this newtab.
    127        type: string
    128      source:
    129        description: >
    130          The source that opened this newtab.
    131          One of
    132            * `about:newtab`
    133            * `about:home`
    134            * `about:welcome`
    135            * `other`
    136          (See `ONBOARDING_ALLOWED_PAGE_VALUES`).
    137        type: string
    138      window_inner_height:
    139        description: >
    140          The height of the page window at time of load.
    141        type: string
    142      window_inner_width:
    143        description: >
    144          The width of the page window at time of load.
    145        type: string
    146    send_in_pings:
    147      - newtab
    148 
    149  closed:
    150    type: event
    151    description: >
    152      Recorded when newtab UI is closed by
    153      * navigation
    154      * closing the tab
    155 
    156      Doesn't mean that the newtab was ever visible to a user.
    157    bugs:
    158      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
    159      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
    160      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
    161    data_reviews:
    162      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
    163      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
    164      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
    165    data_sensitivity:
    166      - interaction
    167    notification_emails:
    168      - anicholson@mozilla.com
    169      - chutten@mozilla.com
    170      - mmccorquodale@mozilla.com
    171      - najiang@mozilla.com
    172      - lina@mozilla.com
    173    expires: never
    174    extra_keys:
    175      newtab_visit_id: *newtab_visit_id
    176    send_in_pings:
    177      - newtab
    178 
    179  blocked_sponsors:
    180    type: string_list
    181    description: >
    182      The advertiser names that have been dismissed by the user.
    183    bugs:
    184      - https://bugzilla.mozilla.org/show_bug.cgi?id=1828234
    185    data_reviews:
    186      - https://bugzilla.mozilla.org/show_bug.cgi?id=1828234#c1
    187    data_sensitivity:
    188      - interaction
    189    notification_emails:
    190      - anicholson@mozilla.com
    191      - chutten@mozilla.com
    192      - mmccorquodale@mozilla.com
    193      - najiang@mozilla.com
    194      - lina@mozilla.com
    195      - ttran@mozilla.com
    196    expires: never
    197    send_in_pings:
    198      - newtab
    199    lifetime: application
    200 
    201  sov_allocation:
    202    type: string_list
    203    description: >
    204      The partner group assignment for sov
    205    bugs:
    206      - https://bugzilla.mozilla.org/show_bug.cgi?id=1840311
    207    data_reviews:
    208      - https://bugzilla.mozilla.org/show_bug.cgi?id=1840311#c3
    209    data_sensitivity:
    210      - technical
    211    notification_emails:
    212      - anicholson@mozilla.com
    213      - chutten@mozilla.com
    214      - mmccorquodale@mozilla.com
    215      - najiang@mozilla.com
    216      - lina@mozilla.com
    217      - ttran@mozilla.com
    218    expires: never
    219    send_in_pings:
    220      - newtab
    221    lifetime: application
    222 
    223  tooltip_click:
    224    type: event
    225    description: >
    226      Recorded when a feature highlight tooltip is opened.
    227    bugs:
    228      - https://bugzilla.mozilla.org/show_bug.cgi?id=1888983
    229    data_reviews:
    230      - https://bugzilla.mozilla.org/show_bug.cgi?id=1888983
    231    data_sensitivity:
    232      - interaction
    233    notification_emails:
    234      - sdowne@mozilla.com
    235    expires: never
    236    extra_keys:
    237      newtab_visit_id: *newtab_visit_id
    238      feature: &feature
    239        description: The feature highlight that was interacted with.
    240        type: string
    241    send_in_pings:
    242      - newtab
    243 
    244  topic_selection_open:
    245    type: event
    246    description: >
    247      Recorded when the topic selection modal is opened
    248    bugs:
    249      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896004
    250    data_reviews:
    251      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896004
    252    data_sensitivity:
    253      - interaction
    254    notification_emails:
    255      - nbarrett@mozilla.com
    256      - mcrawford@mozilla.com
    257    expires: never
    258    extra_keys:
    259      newtab_visit_id: *newtab_visit_id
    260    send_in_pings:
    261      - newtab
    262 
    263  topic_selection_dismiss:
    264    type: event
    265    description: >
    266      Recorded when the topic selection modal is dismissed (topics are not saved)
    267    bugs:
    268      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896004
    269    data_reviews:
    270      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896004
    271    data_sensitivity:
    272      - interaction
    273    notification_emails:
    274      - nbarrett@mozilla.com
    275      - mcrawford@mozilla.com
    276    expires: never
    277    extra_keys:
    278      newtab_visit_id: *newtab_visit_id
    279    send_in_pings:
    280      - newtab
    281 
    282  topic_selection_topics_saved:
    283    type: event
    284    description: >
    285      Recorded when topics are saved from the topics selection modal
    286    bugs:
    287      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896004
    288    data_reviews:
    289      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896004
    290    data_sensitivity:
    291      - interaction
    292    notification_emails:
    293      - nbarrett@mozilla.com
    294      - mcrawford@mozilla.com
    295    expires: never
    296    extra_keys:
    297      newtab_visit_id: *newtab_visit_id
    298      topics:
    299        description: >
    300          list of topics that were saved by user
    301        type: string
    302      previous_topics:
    303        description: >
    304          list of previous topics that were saved, an empty string
    305          means no previous topics were saved
    306        type: string
    307      first_save:
    308        description: >
    309          whether or not it is the user's first time setting topics
    310        type: boolean
    311    send_in_pings:
    312      - newtab
    313 
    314  selected_topics:
    315      type: string_list
    316      description: >
    317        The list of topics the user selected
    318      bugs:
    319        - https://bugzilla.mozilla.org/show_bug.cgi?id=1907152
    320      data_reviews:
    321        - https://bugzilla.mozilla.org/show_bug.cgi?id=1907152
    322      data_sensitivity:
    323        - interaction
    324      notification_emails:
    325        - nbarrett@mozilla.com
    326        - mcrawford@mozilla.com
    327      expires: never
    328      send_in_pings:
    329        - newtab
    330      lifetime: application
    331 
    332  wallpaper_click:
    333    type: event
    334    description: >
    335      Recorded when a user clicks on a wallpaper option
    336    bugs:
    337      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896004
    338    data_reviews:
    339      - https://bugzilla.mozilla.org/show_bug.cgi?id=1896004
    340    data_sensitivity:
    341      - interaction
    342    notification_emails:
    343      - nbarrett@mozilla.com
    344      - mcrawford@mozilla.com
    345    expires: never
    346    extra_keys:
    347      selected_wallpaper:
    348        description: >
    349          Which wallpaper has been selected by the user
    350          Will be the title of a Wallpaper or 'none' for users
    351          that reset the background to default
    352        type: string
    353      had_previous_wallpaper:
    354        description: >
    355          Whether or not user had a previously set wallpaper
    356        type: boolean
    357      had_uploaded_previously:
    358        description: >
    359          Whether or not user had a previously uploaded a custom wallpaper
    360        type: boolean
    361      newtab_visit_id: *newtab_visit_id
    362    send_in_pings:
    363      - newtab
    364 
    365  wallpaper_highlight_cta_click:
    366    type: event
    367    description: >
    368      Recorded when a user clicks the CTA on the wallpaper feature highlight
    369    bugs:
    370      - https://bugzilla.mozilla.org/show_bug.cgi?id=1900854
    371    data_reviews:
    372      - https://bugzilla.mozilla.org/show_bug.cgi?id=1900854
    373    data_sensitivity:
    374      - interaction
    375    notification_emails:
    376      - mcrawford@mozilla.com
    377    expires: never
    378    extra_keys:
    379      newtab_visit_id: *newtab_visit_id
    380    send_in_pings:
    381      - newtab
    382 
    383  wallpaper_highlight_dismissed:
    384    type: event
    385    description: >
    386      Recorded when a user dismisses the wallpaper feature highlight
    387    bugs:
    388      - https://bugzilla.mozilla.org/show_bug.cgi?id=1900854
    389    data_reviews:
    390      - https://bugzilla.mozilla.org/show_bug.cgi?id=1900854
    391    data_sensitivity:
    392      - interaction
    393    notification_emails:
    394      - mcrawford@mozilla.com
    395    expires: never
    396    extra_keys:
    397      newtab_visit_id: *newtab_visit_id
    398    send_in_pings:
    399      - newtab
    400 
    401  wallpaper_category_click:
    402    type: event
    403    description: >
    404      Recorded when a user clicks a wallpaper category option
    405    bugs:
    406     - https://bugzilla.mozilla.org/show_bug.cgi?id=1900420
    407    data_reviews:
    408     - https://bugzilla.mozilla.org/show_bug.cgi?id=1900420
    409    data_sensitivity:
    410      - interaction
    411    notification_emails:
    412     - nbarrett@mozilla.com
    413    expires: never
    414    extra_keys:
    415      selected_category:
    416        description: >
    417          Which wallpaper category selected by user
    418        type: string
    419      newtab_visit_id: *newtab_visit_id
    420    send_in_pings:
    421      - newtab
    422 
    423  weather_change_display:
    424    type: event
    425    description: >
    426      Recorded when a user changes the weather display.
    427    bugs:
    428      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895797
    429    data_reviews:
    430      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895797
    431    data_sensitivity:
    432      - interaction
    433    notification_emails:
    434      - mcrawford@mozilla.com
    435    expires: never
    436    extra_keys:
    437      weather_display_mode: &weather_display_mode
    438        description: >
    439          Which display mode is selected.
    440        type: string
    441      newtab_visit_id: *newtab_visit_id
    442    send_in_pings:
    443      - newtab
    444 
    445  weather_enabled:
    446    lifetime: application
    447    type: boolean
    448    description: >
    449      Whether the weather widget is enabled on the newtab.
    450      Corresponds to the value of the
    451      `browser.newtabpage.activity-stream.showWeather` pref.
    452    bugs:
    453      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899340
    454    data_reviews:
    455      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899340
    456    data_sensitivity:
    457      - interaction
    458    notification_emails:
    459      - mcrawford@mozilla.com
    460      - sdowne@mozilla.com
    461    expires: never
    462    send_in_pings:
    463      - newtab
    464 
    465  weather_open_provider_url:
    466    type: event
    467    description: >
    468      Recorded when a user opens a link to the Weather provider website.
    469    bugs:
    470      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895797
    471    data_reviews:
    472      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895797
    473    data_sensitivity:
    474      - interaction
    475    notification_emails:
    476      - mcrawford@mozilla.com
    477    expires: never
    478    extra_keys:
    479      newtab_visit_id: *newtab_visit_id
    480    send_in_pings:
    481      - newtab
    482 
    483  weather_impression:
    484      type: event
    485      description: >
    486        Recorded when the weather widget is viewed
    487      bugs:
    488        - https://bugzilla.mozilla.org/show_bug.cgi?id=1898275
    489      data_reviews:
    490        - https://bugzilla.mozilla.org/show_bug.cgi?id=1895797
    491      data_sensitivity:
    492        - interaction
    493      notification_emails:
    494        - mcrawford@mozilla.com
    495      expires: never
    496      extra_keys:
    497        newtab_visit_id: *newtab_visit_id
    498      send_in_pings:
    499        - newtab
    500 
    501  weather_load_error:
    502      type: event
    503      description: >
    504        Recorded when the weather widget is not available
    505      bugs:
    506        - https://bugzilla.mozilla.org/show_bug.cgi?id=1898275
    507      data_reviews:
    508        - https://bugzilla.mozilla.org/show_bug.cgi?id=1895797
    509      data_sensitivity:
    510        - interaction
    511      notification_emails:
    512        - mcrawford@mozilla.com
    513      expires: never
    514      extra_keys:
    515        newtab_visit_id: *newtab_visit_id
    516      send_in_pings:
    517        - newtab
    518 
    519  weather_location_selected:
    520      type: event
    521      description: >
    522        Recorded when a user selects a location for weather widget
    523      bugs:
    524        - https://bugzilla.mozilla.org/show_bug.cgi?id=1900103
    525      data_reviews:
    526        - https://bugzilla.mozilla.org/show_bug.cgi?id=1900103
    527      data_sensitivity:
    528        - interaction
    529      notification_emails:
    530        - nbarrett@mozilla.com
    531      expires: never
    532      extra_keys:
    533        newtab_visit_id: *newtab_visit_id
    534      send_in_pings:
    535        - newtab
    536 
    537  weather_opt_in_selection:
    538      type: event
    539      description: >
    540        Recorded when a user answers the location opt-in prompt
    541      bugs:
    542        - https://bugzilla.mozilla.org/show_bug.cgi?id=1989875
    543      data_reviews:
    544        - https://bugzilla.mozilla.org/show_bug.cgi?id=1989875
    545      data_sensitivity:
    546        - interaction
    547      notification_emails:
    548        - rhamoui@mozilla.com
    549      expires: never
    550      extra_keys:
    551        user_selection:
    552          description: >
    553           User's selection when interacting with weather opt-in.
    554          type: string
    555        newtab_visit_id: *newtab_visit_id
    556      send_in_pings:
    557        - newtab
    558 
    559  weather_detect_location:
    560      type: event
    561      description: >
    562        Recorded when a user selects 'detect my location' from weather context menu
    563      bugs:
    564        - https://bugzilla.mozilla.org/show_bug.cgi?id=1992647
    565      data_reviews:
    566        - https://bugzilla.mozilla.org/show_bug.cgi?id=1992647
    567      data_sensitivity:
    568        - interaction
    569      notification_emails:
    570        - rhamoui@mozilla.com
    571      expires: never
    572      extra_keys:
    573        newtab_visit_id: *newtab_visit_id
    574      send_in_pings:
    575        - newtab
    576 
    577  sections_impression:
    578    type: event
    579    description: >
    580      Recorded when a section is viewport and triggers an impression event
    581    bugs:
    582      - https://bugzilla.mozilla.org/show_bug.cgi?id=1927916
    583      - https://bugzilla.mozilla.org/show_bug.cgi?id=1938215
    584    data_reviews:
    585      - https://bugzilla.mozilla.org/show_bug.cgi?id=1927916
    586    data_sensitivity:
    587      - interaction
    588    notification_emails:
    589      - nbarrett@mozilla.com
    590      - mcrawford@mozilla.com
    591    expires: never
    592    extra_keys:
    593      newtab_visit_id: *newtab_visit_id
    594      section:
    595        description: >
    596          section that had impression event
    597        type: string
    598      section_position:
    599        description: >
    600          position of section on newtab
    601        type: string
    602      is_section_followed: &is_section_followed
    603        description: >
    604          If click belongs in a section, if that section is followed
    605        type: boolean
    606      content_redacted:
    607        description: >
    608          Are content details sent separately in the newtab_content ping
    609        type: boolean
    610      layout_name: &layout_name
    611        description: >
    612          description of the section layout
    613        type: string
    614    send_in_pings:
    615      - newtab
    616 
    617  sections_follow_section:
    618    type: event
    619    description: >
    620      Recorded when a section is followed
    621    bugs:
    622      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
    623    data_reviews:
    624      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
    625    data_sensitivity:
    626      - interaction
    627    notification_emails:
    628      - mcrawford@mozilla.com
    629    expires: never
    630    extra_keys:
    631      newtab_visit_id: *newtab_visit_id
    632      section:
    633        description: >
    634          section that had impression event
    635        type: string
    636      section_position:
    637        description: >
    638          position of section on newtab
    639        type: string
    640      event_source: &event_source
    641        description: >
    642          Where the source of the event originated ("button", "context menu", etc.)
    643        type: string
    644      content_redacted:
    645        description: >
    646          Are content details sent separately in the newtab_content ping
    647        type: boolean
    648    send_in_pings:
    649      - newtab
    650 
    651  sections_unfollow_section:
    652    type: event
    653    description: >
    654      Recorded when a section is unfollowed
    655    bugs:
    656      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
    657    data_reviews:
    658      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
    659    data_sensitivity:
    660      - interaction
    661    notification_emails:
    662      - mcrawford@mozilla.com
    663    expires: never
    664    extra_keys:
    665      newtab_visit_id: *newtab_visit_id
    666      section:
    667        description: >
    668          section that had impression event
    669        type: string
    670      section_position:
    671        description: >
    672          position of section on newtab
    673        type: string
    674      event_source: *event_source
    675      content_redacted:
    676        description: >
    677          Are content details sent separately in the newtab_content ping
    678        type: boolean
    679    send_in_pings:
    680      - newtab
    681 
    682  sections_block_section:
    683    type: event
    684    description: >
    685      Recorded when a section is blocked
    686    bugs:
    687      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
    688    data_reviews:
    689      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
    690    data_sensitivity:
    691      - interaction
    692    notification_emails:
    693      - mcrawford@mozilla.com
    694    expires: never
    695    extra_keys:
    696      newtab_visit_id: *newtab_visit_id
    697      section:
    698        description: >
    699          section that had impression event
    700        type: string
    701      section_position:
    702        description: >
    703          position of section on newtab
    704        type: string
    705      event_source: *event_source
    706      content_redacted:
    707        description: >
    708          Are content details sent separately in the newtab_content ping
    709        type: boolean
    710    send_in_pings:
    711      - newtab
    712 
    713  sections_unblock_section:
    714    type: event
    715    description: >
    716      Recorded when a section is unblocked
    717    bugs:
    718      - https://bugzilla.mozilla.org/show_bug.cgi?id=1940566
    719    data_reviews:
    720      - https://bugzilla.mozilla.org/show_bug.cgi?id=1940566
    721    data_sensitivity:
    722      - interaction
    723    notification_emails:
    724      - mcrawford@mozilla.com
    725    expires: never
    726    extra_keys:
    727      newtab_visit_id: *newtab_visit_id
    728      section:
    729        description: >
    730          section that had unblock event
    731        type: string
    732      section_position:
    733        description: >
    734          position of section on newtab
    735        type: string
    736      event_source: *event_source
    737      content_redacted:
    738        description: >
    739          Are content details sent separately in the newtab_content ping
    740        type: boolean
    741    send_in_pings:
    742      - newtab
    743 
    744  inline_selection_impression:
    745    type: event
    746    description: >
    747      Recorded when there is an impression on the inline selection component
    748    bugs:
    749      - https://bugzilla.mozilla.org/show_bug.cgi?id=1943474
    750    data_reviews:
    751      - https://bugzilla.mozilla.org/show_bug.cgi?id=1943474
    752    data_sensitivity:
    753      - interaction
    754    notification_emails:
    755      - nbarrett@mozilla.com
    756    expires: never
    757    extra_keys:
    758      newtab_visit_id: *newtab_visit_id
    759      section_position:
    760        description: >
    761          position of the inline selection component (index point within sections)
    762        type: string
    763    send_in_pings:
    764      - newtab
    765 
    766  inline_selection_click:
    767    type: event
    768    description: >
    769      Recorded when there is a click on the inline selection component
    770    bugs:
    771      - https://bugzilla.mozilla.org/show_bug.cgi?id=1943474
    772    data_reviews:
    773      - https://bugzilla.mozilla.org/show_bug.cgi?id=1943474
    774    data_sensitivity:
    775      - interaction
    776    notification_emails:
    777      - nbarrett@mozilla.com
    778    expires: never
    779    extra_keys:
    780      newtab_visit_id: *newtab_visit_id
    781      topic:
    782        description: >
    783          unique id of topic that was clicked
    784        type: string
    785      is_followed:
    786        description: >
    787          whether the click followed a topic or unfollowed. True for followed, false for unfollowed
    788        type: boolean
    789      section_position:
    790        description: >
    791          position of the inline selection component (index point within sections)
    792        type: string
    793      topic_position:
    794        description: >
    795          position of the topic within the inline selection component (index point starting at 0)
    796        type: string
    797    send_in_pings:
    798      - newtab
    799 
    800  promo_card_impression:
    801    type: event
    802    description: Recorded when the promo card is visible
    803    bugs:
    804      - https://bugzilla.mozilla.org/show_bug.cgi?id=1981817
    805    data_reviews:
    806      - https://bugzilla.mozilla.org/show_bug.cgi?id=1981817
    807    data_sensitivity:
    808      - interaction
    809    notification_emails:
    810      - achurchwell@mozilla.com
    811    expires: never
    812    extra_keys:
    813      newtab_visit_id: *newtab_visit_id
    814    send_in_pings:
    815      - newtab
    816 
    817  promo_card_click:
    818    type: event
    819    description: Recorded when there is a click on the promo card cta
    820    bugs:
    821      - https://bugzilla.mozilla.org/show_bug.cgi?id=1981817
    822    data_reviews:
    823      - https://bugzilla.mozilla.org/show_bug.cgi?id=1981817
    824    data_sensitivity:
    825      - interaction
    826    notification_emails:
    827      - achurchwell@mozilla.com
    828    expires: never
    829    extra_keys:
    830      newtab_visit_id: *newtab_visit_id
    831    send_in_pings:
    832      - newtab
    833 
    834  promo_card_dismiss:
    835    type: event
    836    description: Recorded when the promo card is dismissed
    837    bugs:
    838      - https://bugzilla.mozilla.org/show_bug.cgi?id=1981817
    839    data_reviews:
    840      - https://bugzilla.mozilla.org/show_bug.cgi?id=1981817
    841    data_sensitivity:
    842      - interaction
    843    notification_emails:
    844      - achurchwell@mozilla.com
    845    expires: never
    846    extra_keys:
    847      newtab_visit_id: *newtab_visit_id
    848    send_in_pings:
    849      - newtab
    850 
    851  abouthome_cache_construction:
    852    type: timing_distribution
    853    description: >
    854      The length of time (in milliseconds) that it takes for the cache worker to
    855      generate the cache and return it to the main thread
    856 
    857      This metric was generated to correspond to the Legacy Telemetry
    858      exponential histogram FX_ABOUTHOME_CACHE_CONSTRUCTION.
    859    time_unit: millisecond
    860    bugs:
    861      - https://bugzilla.mozilla.org/show_bug.cgi?id=1622263
    862      - https://bugzilla.mozilla.org/show_bug.cgi?id=1683101
    863      - https://bugzilla.mozilla.org/show_bug.cgi?id=1714258
    864      - https://bugzilla.mozilla.org/show_bug.cgi?id=1730042
    865      - https://bugzilla.mozilla.org/show_bug.cgi?id=1754641
    866      - https://bugzilla.mozilla.org/show_bug.cgi?id=1781978
    867      - https://bugzilla.mozilla.org/show_bug.cgi?id=1811151
    868      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841926
    869    data_reviews:
    870      - https://bugzilla.mozilla.org/show_bug.cgi?id=1622263
    871      - https://bugzilla.mozilla.org/show_bug.cgi?id=1683101
    872      - https://bugzilla.mozilla.org/show_bug.cgi?id=1714258
    873      - https://bugzilla.mozilla.org/show_bug.cgi?id=1730042
    874      - https://bugzilla.mozilla.org/show_bug.cgi?id=1754641
    875      - https://bugzilla.mozilla.org/show_bug.cgi?id=1781978
    876      - https://bugzilla.mozilla.org/show_bug.cgi?id=1811151
    877      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841926
    878    notification_emails:
    879      - mconley@mozilla.com
    880    expires: never
    881    telemetry_mirror: FX_ABOUTHOME_CACHE_CONSTRUCTION
    882 
    883  metric_registered:
    884    type: labeled_boolean
    885    description: >
    886      Records technical data about whether the metric registration
    887      at runtime succeeded
    888    bugs:
    889      - https://bugzil.la/1961989
    890    data_reviews:
    891      - https://bugzil.la/1961989
    892    data_sensitivity:
    893      - technical
    894    notification_emails:
    895      - pdahiya@mozilla.com
    896      - mconley@mozilla.com
    897    expires: never
    898 
    899  ping_registered:
    900    type: labeled_boolean
    901    description: >
    902      Records technical data about whether the ping registration
    903      at runtime succeeded
    904    bugs:
    905      - https://bugzil.la/1961989
    906    data_reviews:
    907      - https://bugzil.la/1961989
    908    data_sensitivity:
    909      - technical
    910    notification_emails:
    911      - pdahiya@mozilla.com
    912      - mconley@mozilla.com
    913    expires: never
    914 
    915  activity_stream_ctor_success:
    916    type: boolean
    917    description: >
    918      Records technical data about whether Activity Stream
    919      construction completed successfully
    920    bugs:
    921      - https://bugzil.la/1965278
    922    data_reviews:
    923      - https://bugzil.la/1965278
    924    data_sensitivity:
    925      - technical
    926    notification_emails:
    927      - pdahiya@mozilla.com
    928      - mconley@mozilla.com
    929    expires: never
    930 
    931  addon_ready_success:
    932    type: boolean
    933    description: >
    934      Records technical data about whether waiting for the newtab built-in
    935      addon readyPromise succeeded.
    936    bugs:
    937      - https://bugzil.la/1965923
    938    data_reviews:
    939      - https://bugzil.la/1965923
    940    data_sensitivity:
    941      - technical
    942    notification_emails:
    943      - pdahiya@mozilla.com
    944      - mconley@mozilla.com
    945    expires: never
    946 
    947  addon_xpi_used:
    948    type: boolean
    949    description: >
    950      True if a downloaded XPI file is where the newtab resources are being
    951      mapped from.
    952    bugs:
    953      - https://bugzil.la/1978061
    954    data_reviews:
    955      - https://bugzil.la/1978061
    956    data_sensitivity:
    957      - technical
    958    notification_emails:
    959      - pdahiya@mozilla.com
    960      - mconley@mozilla.com
    961    expires: never
    962 
    963  feature_highlight_dismiss:
    964    type: event
    965    description: >
    966      recorded when a feature highlight is dismissed
    967    bugs:
    968      - https://bugzil.la/1972931
    969    data_reviews:
    970      - https://bugzil.la/1972931
    971    data_sensitivity:
    972      - interaction
    973    notification_emails:
    974      - mcrawford@mozilla.com
    975    expires: never
    976    extra_keys:
    977      newtab_visit_id: *newtab_visit_id
    978      feature: *feature
    979    send_in_pings:
    980      - newtab
    981 
    982  feature_highlight_impression:
    983    type: event
    984    description: >
    985        recorded when a feature highlight impression occurs
    986    bugs:
    987      - https://bugzil.la/1972931
    988    data_reviews:
    989      - https://bugzil.la/1972931
    990    data_sensitivity:
    991      - interaction
    992    notification_emails:
    993      - mcrawford@mozilla.com
    994    expires: never
    995    extra_keys:
    996      newtab_visit_id: *newtab_visit_id
    997      feature: *feature
    998    send_in_pings:
    999      - newtab
   1000 
   1001  feature_highlight_open:
   1002    type: event
   1003    description: >
   1004        recorded when a feature highlight is opened
   1005    bugs:
   1006      - https://bugzil.la/1972931
   1007    data_reviews:
   1008      - https://bugzil.la/1972931
   1009    data_sensitivity:
   1010      - interaction
   1011    notification_emails:
   1012      - mcrawford@mozilla.com
   1013    expires: never
   1014    extra_keys:
   1015      newtab_visit_id: *newtab_visit_id
   1016      feature: *feature
   1017    send_in_pings:
   1018      - newtab
   1019 
   1020  widgets_lists_user_event:
   1021    type: event
   1022    description: >
   1023      Details which user action has occurred. It can be one of
   1024      the following: list_copy, list_create, list_edit, list_delete,
   1025      task_create, task_edit task_delete and task_completed
   1026    bugs:
   1027      - https://bugzil.la/1979704
   1028    data_reviews:
   1029      - https://bugzil.la/1979704
   1030    data_sensitivity:
   1031      - interaction
   1032    notification_emails:
   1033      - nbarrett@mozilla.com
   1034    expires: never
   1035    extra_keys:
   1036      newtab_visit_id: *newtab_visit_id
   1037      user_action:
   1038        description: >
   1039          user action. One of list_copy, list_create, list_edit, list_delete,
   1040          task_create, task_edit task_delete and task_completed
   1041        type: string
   1042    send_in_pings:
   1043      - newtab
   1044 
   1045  widgets_lists_impression:
   1046    type: event
   1047    description: >
   1048      Recorded when the list widget is viewable on a users screen
   1049    bugs:
   1050      - https://bugzil.la/1979704
   1051    data_reviews:
   1052      - https://bugzil.la/1979704
   1053    data_sensitivity:
   1054      - interaction
   1055    notification_emails:
   1056      - nbarrett@mozilla.com
   1057    expires: never
   1058    extra_keys:
   1059      newtab_visit_id: *newtab_visit_id
   1060    send_in_pings:
   1061      - newtab
   1062 
   1063  widgets_lists_change_display:
   1064    type: event
   1065    description: >
   1066      Whether the lists widget is enabled. Matches
   1067      the `widgets.lists.enabled` pref
   1068    bugs:
   1069      - https://bugzil.la/1979704
   1070    data_reviews:
   1071      - https://bugzil.la/1979704
   1072    data_sensitivity:
   1073      - interaction
   1074    notification_emails:
   1075      - nbarrett@mozilla.com
   1076    expires: never
   1077    extra_keys:
   1078      newtab_visit_id: *newtab_visit_id
   1079      display_status:
   1080        description: boolean value if the lists widget is being visible/enabled
   1081        type: boolean
   1082    send_in_pings:
   1083      - newtab
   1084 
   1085  widgets_timer_user_event:
   1086    type: event
   1087    description: >
   1088      Details which user action has occurred. It can be one of
   1089      the following: timer_set, timer_play, timer_pause, timer_reset,
   1090      timer_toggle_focus, timer_toggle_break, timer_end
   1091    bugs:
   1092      - https://bugzil.la/1977301
   1093    data_reviews:
   1094      - https://bugzil.la/1977301
   1095    data_sensitivity:
   1096      - interaction
   1097    notification_emails:
   1098      - rhamoui@mozilla.com
   1099    expires: never
   1100    extra_keys:
   1101      newtab_visit_id: *newtab_visit_id
   1102      user_action:
   1103        description: >
   1104          user action. timer_set, timer_play, timer_pause, timer_reset,
   1105          timer_toggle_focus, timer_toggle_break, timer_end
   1106        type: string
   1107    send_in_pings:
   1108      - newtab
   1109 
   1110  widgets_timer_impression:
   1111    type: event
   1112    description: >
   1113      Recorded when the timer widget is viewable on a users screen
   1114    bugs:
   1115      - https://bugzil.la/1977301
   1116    data_reviews:
   1117      - https://bugzil.la/1977301
   1118    data_sensitivity:
   1119      - interaction
   1120    notification_emails:
   1121      - rhamoui@mozilla.com
   1122    expires: never
   1123    extra_keys:
   1124      newtab_visit_id: *newtab_visit_id
   1125    send_in_pings:
   1126      - newtab
   1127 
   1128  widgets_timer_change_display:
   1129    type: event
   1130    description: >
   1131      Whether the timer widget is enabled. Matches
   1132      the `widgets.focusTimer.enabled` pref
   1133    bugs:
   1134      - https://bugzil.la/1977301
   1135    data_reviews:
   1136      - https://bugzil.la/1977301
   1137    data_sensitivity:
   1138      - interaction
   1139    notification_emails:
   1140      - rhamoui@mozilla.com
   1141    expires: never
   1142    extra_keys:
   1143      newtab_visit_id: *newtab_visit_id
   1144      display_status:
   1145        description: boolean value if the timer widget is being visible/enabled
   1146        type: boolean
   1147    send_in_pings:
   1148      - newtab
   1149 
   1150  widgets_timer_toggle_notification:
   1151    type: event
   1152    description: >
   1153      Whether the timer widget's notification pref is enabled. Matches
   1154      the `widgets.focusTimer.showSystemNotifications` pref
   1155    bugs:
   1156      - https://bugzil.la/1982516
   1157    data_reviews:
   1158      - https://bugzil.la/1982516
   1159    data_sensitivity:
   1160      - interaction
   1161    notification_emails:
   1162      - rhamoui@mozilla.com
   1163    expires: never
   1164    extra_keys:
   1165      newtab_visit_id: *newtab_visit_id
   1166      display_status:
   1167        description: boolean value if the timer widget notification is enabled
   1168        type: boolean
   1169    send_in_pings:
   1170      - newtab
   1171 
   1172  spons_nav_traffic_sent:
   1173    type: memory_distribution
   1174    memory_unit: kilobyte
   1175    description: >
   1176      The volume of traffic sent through browsers that were link targets for
   1177      sponsored topsite or content navigations.
   1178    bugs:
   1179      - https://bugzil.la/1978161
   1180    data_reviews:
   1181      - https://bugzil.la/1978161
   1182    notification_emails:
   1183      - mconley@mozilla.com
   1184    expires: never
   1185 
   1186  spons_nav_traffic_recvd:
   1187    type: memory_distribution
   1188    memory_unit: kilobyte
   1189    description: >
   1190      The volume of traffic received through browsers that were link targets
   1191      for sponsored topsite or content navigations.
   1192    bugs:
   1193      - https://bugzil.la/1978161
   1194    data_reviews:
   1195      - https://bugzil.la/1978161
   1196    notification_emails:
   1197      - mconley@mozilla.com
   1198    expires: never
   1199 
   1200  highlights_enabled:
   1201    lifetime: application
   1202    type: boolean
   1203    description: >
   1204      Whether "highlights" is enabled on the newtab.
   1205      AKA the "Recent Activity" section.
   1206      Corresponds to the value of the
   1207      `browser.newtabpage.activity-stream.feeds.section.highlights` pref.
   1208    bugs:
   1209      - https://bugzilla.mozilla.org/show_bug.cgi?id=1992486
   1210    data_reviews:
   1211      - https://bugzilla.mozilla.org/show_bug.cgi?id=1992486
   1212    data_sensitivity:
   1213      - technical
   1214    notification_emails:
   1215      - mconley@Mozilla.com
   1216    expires: never
   1217    send_in_pings:
   1218      - newtab
   1219 
   1220 newtab.search:
   1221  enabled:
   1222    lifetime: application
   1223    type: boolean
   1224    description: >
   1225      Whether the search input is enabled on the newtab.
   1226      Corresponds to the value of the
   1227      `browser.newtabpage.activity-stream.showSearch` pref.
   1228    bugs:
   1229      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1230      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1231    data_reviews:
   1232      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1233      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1234    data_sensitivity:
   1235      - technical
   1236    notification_emails:
   1237      - anicholson@mozilla.com
   1238      - chutten@mozilla.com
   1239      - mmccorquodale@mozilla.com
   1240      - najiang@mozilla.com
   1241      - lina@mozilla.com
   1242    expires: never
   1243    send_in_pings:
   1244      - newtab
   1245 
   1246 topsites:
   1247  enabled:
   1248    lifetime: application
   1249    type: boolean
   1250    description: >
   1251      Whether "topsites" is enabled on the newtab.
   1252      AKA the "Shortcuts" section.
   1253      Corresponds to the value of the
   1254      `browser.newtabpage.activity-stream.feeds.topsites` pref.
   1255    bugs:
   1256      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1257      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1258    data_reviews:
   1259      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1260      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1261    data_sensitivity:
   1262      - technical
   1263    notification_emails:
   1264      - anicholson@mozilla.com
   1265      - chutten@mozilla.com
   1266      - mmccorquodale@mozilla.com
   1267      - najiang@mozilla.com
   1268      - lina@mozilla.com
   1269    expires: never
   1270    send_in_pings:
   1271      - newtab
   1272 
   1273  sponsored_enabled:
   1274    lifetime: application
   1275    type: boolean
   1276    description: >
   1277      Whether sponsored topsites are enabled on the newtab.
   1278      AKA the "Sponsored Shortcuts" section.
   1279      Corresponds to the value of the
   1280      `browser.newtabpage.activity-stream.showSponsoredTopSites` pref.
   1281      Can be `true` even if topsites.enabled is `false`.
   1282    bugs:
   1283      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1284      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1285    data_reviews:
   1286      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1287      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1288    data_sensitivity:
   1289      - technical
   1290    notification_emails:
   1291      - anicholson@mozilla.com
   1292      - chutten@mozilla.com
   1293      - mmccorquodale@mozilla.com
   1294      - najiang@mozilla.com
   1295      - lina@mozilla.com
   1296    expires: never
   1297    send_in_pings:
   1298      - newtab
   1299 
   1300  impression:
   1301    type: event
   1302    description: >
   1303      Recorded when topsite tiles are loaded.
   1304    bugs:
   1305      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
   1306      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
   1307      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1308      - https://bugzilla.mozilla.org/show_bug.cgi?id=1820707
   1309    data_reviews:
   1310      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
   1311      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
   1312      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1313      - https://bugzilla.mozilla.org/show_bug.cgi?id=1820707#c3
   1314      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821556#c3
   1315      - https://bugzilla.mozilla.org/show_bug.cgi?id=1824842#c7
   1316      - https://bugzilla.mozilla.org/show_bug.cgi?id=1996666#c7
   1317    data_sensitivity:
   1318      - interaction
   1319    notification_emails:
   1320      - anicholson@mozilla.com
   1321      - chutten@mozilla.com
   1322      - mmccorquodale@mozilla.com
   1323      - najiang@mozilla.com
   1324      - lina@mozilla.com
   1325    expires: never
   1326    extra_keys:
   1327      advertiser_name: &advertiser_name
   1328        description: >
   1329          The name of the advertiser of the tile
   1330        type: string
   1331      tile_id: &tile_id
   1332        description: >
   1333          The tile id of the advertiser provided by Contile. Like `74357`.
   1334        type: quantity
   1335      newtab_visit_id: *newtab_visit_id
   1336      is_sponsored: &is_sponsored
   1337        description: Whether the topsite tile was sponsored.
   1338        type: boolean
   1339      position: &topsite_position
   1340        description: The position (0-index) of the topsite tile.
   1341        type: quantity
   1342      is_pinned: &is_pinned
   1343        description: Whether the topsite tile is pinned.
   1344        type: boolean
   1345      visible_topsites: &visible_topsites
   1346        description: The quantity of visible topsites when event occurred
   1347        type: quantity
   1348      smart_scores: &smart_scores
   1349        description: stringified json storing scores for each feature during smart shortcut ranking
   1350        type: string
   1351      smart_weights: &smart_weights
   1352        description: stringified json storing weights for each feature during smart shortcut ranking
   1353        type: string
   1354    send_in_pings:
   1355      - newtab
   1356 
   1357  click:
   1358    type: event
   1359    description: >
   1360      Recorded when a topsite tile is clicked.
   1361      Only happens on click. Not on middle-click. Not on "Open in new Tab"-like
   1362      options in the context menu.
   1363    bugs:
   1364      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
   1365      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
   1366      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1367      - https://bugzilla.mozilla.org/show_bug.cgi?id=1820707
   1368    data_reviews:
   1369      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
   1370      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
   1371      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1372      - https://bugzilla.mozilla.org/show_bug.cgi?id=1820707#c3
   1373      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821556#c3
   1374      - https://bugzilla.mozilla.org/show_bug.cgi?id=1824842#c7
   1375      - https://bugzilla.mozilla.org/show_bug.cgi?id=1996666#c7
   1376    data_sensitivity:
   1377      - interaction
   1378    notification_emails:
   1379      - anicholson@mozilla.com
   1380      - chutten@mozilla.com
   1381      - mmccorquodale@mozilla.com
   1382      - najiang@mozilla.com
   1383      - lina@mozilla.com
   1384    expires: never
   1385    extra_keys:
   1386      advertiser_name: *advertiser_name
   1387      tile_id: *tile_id
   1388      newtab_visit_id: *newtab_visit_id
   1389      is_sponsored: *is_sponsored
   1390      position: *topsite_position
   1391      is_pinned: *is_pinned
   1392      visible_topsites: *visible_topsites
   1393      smart_scores: *smart_scores
   1394      smart_weights: *smart_weights
   1395    send_in_pings:
   1396      - newtab
   1397 
   1398  pin:
   1399    type: event
   1400    description: >
   1401      Recorded when a topsite tile is pinned.
   1402    bugs:
   1403      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968053
   1404    data_reviews:
   1405      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968053
   1406    data_sensitivity:
   1407      - interaction
   1408    notification_emails:
   1409      - sdowne@mozilla.com
   1410      - achurchwell@mozilla.com
   1411    expires: never
   1412    extra_keys:
   1413      advertiser_name: *advertiser_name
   1414      tile_id: *tile_id
   1415      newtab_visit_id: *newtab_visit_id
   1416      is_sponsored: *is_sponsored
   1417      position: *topsite_position
   1418    send_in_pings:
   1419      - newtab
   1420 
   1421  unpin:
   1422    type: event
   1423    description: >
   1424      Recorded when a topsite tile is unpinned.
   1425    bugs:
   1426      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968053
   1427    data_reviews:
   1428      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968053
   1429    data_sensitivity:
   1430      - interaction
   1431    notification_emails:
   1432      - sdowne@mozilla.com
   1433      - achurchwell@mozilla.com
   1434    expires: never
   1435    extra_keys:
   1436      advertiser_name: *advertiser_name
   1437      tile_id: *tile_id
   1438      newtab_visit_id: *newtab_visit_id
   1439      is_sponsored: *is_sponsored
   1440      position: *topsite_position
   1441    send_in_pings:
   1442      - newtab
   1443 
   1444  add:
   1445    type: event
   1446    description: >
   1447      Recorded when a topsite tile is added
   1448    bugs:
   1449      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968053
   1450    data_reviews:
   1451      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968053
   1452    data_sensitivity:
   1453      - interaction
   1454    notification_emails:
   1455      - sdowne@mozilla.com
   1456      - achurchwell@mozilla.com
   1457    expires: never
   1458    extra_keys:
   1459      advertiser_name: *advertiser_name
   1460      tile_id: *tile_id
   1461      newtab_visit_id: *newtab_visit_id
   1462      is_sponsored: *is_sponsored
   1463      position: *topsite_position
   1464    send_in_pings:
   1465      - newtab
   1466 
   1467  edit:
   1468    type: event
   1469    description: >
   1470      Recorded when a topsite tile is edited
   1471    bugs:
   1472      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968053
   1473    data_reviews:
   1474      - https://bugzilla.mozilla.org/show_bug.cgi?id=1968053
   1475    data_sensitivity:
   1476      - interaction
   1477    notification_emails:
   1478      - sdowne@mozilla.com
   1479      - achurchwell@mozilla.com
   1480    expires: never
   1481    extra_keys:
   1482      advertiser_name: *advertiser_name
   1483      tile_id: *tile_id
   1484      newtab_visit_id: *newtab_visit_id
   1485      is_sponsored: *is_sponsored
   1486      position: *topsite_position
   1487      has_title_changed: &has_title_changed
   1488        description: Whether the topsite title was changed.
   1489        type: boolean
   1490      has_url_changed: &has_url_changed
   1491        description: Whether the topsite URL was changed.
   1492        type: boolean
   1493    send_in_pings:
   1494      - newtab
   1495 
   1496  show_privacy_click:
   1497    type: event
   1498    description: >
   1499      Recorded when the "Our Sponsors and Your Privacy" menu item in the three-
   1500      dots menu of a sponsored topsite is clicked.
   1501      Corresponds to the receipt of a dispatched `ABOUT_SPONSORED_TOP_SITES`
   1502      action by `TelemetryFeed`.
   1503    bugs:
   1504      - https://mozilla-hub.atlassian.net/browse/DENG-1364
   1505      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
   1506    data_reviews:
   1507      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
   1508    data_sensitivity: [interaction]
   1509    notification_emails:
   1510      - chutten@mozilla.com
   1511      - mmccorquodale@mozilla.com
   1512      - sbetancourt@mozilla.com
   1513    expires: never
   1514    extra_keys:
   1515      advertiser_name: *advertiser_name
   1516      tile_id: *tile_id
   1517      newtab_visit_id: *newtab_visit_id
   1518      position: *topsite_position
   1519    send_in_pings:
   1520      - newtab
   1521 
   1522  dismiss:
   1523    type: event
   1524    description: >
   1525      Recorded when the "Dismiss" menu item in the three-dots menu of a topsite
   1526      is clicked.
   1527      Corresponds to the receipt of a dispatched `BLOCK_URL` action by
   1528      `TelemetryFeed`.
   1529      Applies to both sponsored and non-sponsored topsites.
   1530      `advertiser_name` is only provided for sponsored topsites.
   1531    bugs:
   1532      - https://mozilla-hub.atlassian.net/browse/DENG-1363
   1533      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
   1534    data_reviews:
   1535      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
   1536    data_sensitivity: [interaction]
   1537    notification_emails:
   1538      - chutten@mozilla.com
   1539      - mmccorquodale@mozilla.com
   1540      - sbetancourt@mozilla.com
   1541      - kdemtchouk@mozilla.com
   1542      - mbowerman@mozilla.com
   1543    expires: never
   1544    extra_keys:
   1545      advertiser_name: *advertiser_name
   1546      tile_id: *tile_id
   1547      newtab_visit_id: *newtab_visit_id
   1548      is_sponsored: *is_sponsored
   1549      position: *topsite_position
   1550      content_redacted:
   1551        description: >
   1552          Are content details sent separately in the newtab_content ping
   1553        type: boolean
   1554    send_in_pings:
   1555      - newtab
   1556 
   1557  pref_changed:
   1558    type: event
   1559    description: >
   1560      Recorded when specific topsites prefs have changed.
   1561 
   1562      The list of possible prefs is presently:
   1563       * browser.newtabpage.activity-stream.feeds.topsites
   1564       * browser.newtabpage.activity-stream.showSponsoredTopSites
   1565    bugs:
   1566      - https://mozilla-hub.atlassian.net/browse/D0-1293
   1567      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
   1568    data_reviews:
   1569      - https://bugzilla.mozilla.org/show_bug.cgi?id=1857324
   1570    data_sensitivity: [interaction]
   1571    notification_emails:
   1572      - chutten@mozilla.com
   1573      - mmccorquodale@mozilla.com
   1574      - sbetancourt@mozilla.com
   1575      - kdemtchouk@mozilla.com
   1576      - mbowerman@mozilla.com
   1577    expires: never
   1578    extra_keys:
   1579      pref_name:
   1580        description: The full name of the pref whose value just changed.
   1581        type: string
   1582      new_value:
   1583        description: The new (current) value the pref just changed to.
   1584        type: boolean
   1585    send_in_pings:
   1586      - newtab
   1587 
   1588  rows:
   1589    lifetime: application
   1590    type: quantity
   1591    unit: integer
   1592    description: >
   1593      The number of topsite tile rows configured to be shown on the newtab
   1594      page. Corresponds to the value of the
   1595      `browser.newtabpage.activity-stream.topSitesRows` pref. This is not the
   1596      number of rows actually seen by the user: if the browser window is
   1597      partially off-screen, or isn't wide enough to accommodate eight tiles per
   1598      row, the actual number of rows may be different.
   1599    bugs:
   1600      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821556
   1601    data_reviews:
   1602      - https://bugzilla.mozilla.org/show_bug.cgi?id=1821556#c3
   1603    data_sensitivity:
   1604      - interaction
   1605    notification_emails:
   1606      - anicholson@mozilla.com
   1607      - chutten@mozilla.com
   1608      - mmccorquodale@mozilla.com
   1609      - najiang@mozilla.com
   1610      - lina@mozilla.com
   1611    expires: never
   1612    send_in_pings:
   1613      - newtab
   1614 
   1615  sponsored_tiles_configured:
   1616    lifetime: application
   1617    type: quantity
   1618    unit: integer
   1619    description: >
   1620      The number of topsite tiles configured to be shown on newtab.
   1621    bugs:
   1622      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862493
   1623    data_reviews:
   1624      - https://bugzilla.mozilla.org/show_bug.cgi
   1625    data_sensitivity:
   1626      - technical
   1627    notification_emails:
   1628      - gleonard@mozilla.com
   1629    expires: never
   1630    send_in_pings:
   1631      - newtab
   1632 
   1633  sponsored_tiles_received:
   1634    lifetime: application
   1635    type: text
   1636    description: >
   1637      The stringified JSON of tiles processed for display (array of objects).
   1638      Includes tiles not displayed and reason for not displaying.
   1639      Fields included: advertiser, provider, display_position,
   1640      display_fail_reason.
   1641    bugs:
   1642      - https://bugzilla.mozilla.org/show_bug.cgi
   1643    data_reviews:
   1644      - https://bugzilla.mozilla.org/show_bug.cgi
   1645    data_sensitivity:
   1646      - web_activity
   1647    notification_emails:
   1648      - gleonard@mozilla.com
   1649    expires: never
   1650    send_in_pings:
   1651      - newtab
   1652 
   1653 pocket:
   1654  is_signed_in:
   1655    lifetime: application
   1656    type: boolean
   1657    description: >
   1658      Whether the Firefox user is signed in to Pocket.
   1659      Does not correspond to a pref, so its value is resampled at newtab's
   1660      component init and whenever there is a Discovery Stream user event.
   1661    bugs:
   1662      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1663      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1664    data_reviews:
   1665      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1666      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1667    data_sensitivity:
   1668      - technical
   1669    notification_emails:
   1670      - anicholson@mozilla.com
   1671      - chutten@mozilla.com
   1672      - mmccorquodale@mozilla.com
   1673      - najiang@mozilla.com
   1674      - lina@mozilla.com
   1675    expires: never
   1676    send_in_pings:
   1677      - newtab
   1678 
   1679  enabled:
   1680    lifetime: application
   1681    type: boolean
   1682    description: >
   1683      Whether Pocket is enabled on the newtab.
   1684      AKA the "Recommended by Pocket" section.
   1685      Corresponds to the value of the
   1686      `browser.newtabpage.activity-stream.feeds.section.topstories` pref.
   1687    bugs:
   1688      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1689      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1690    data_reviews:
   1691      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1692      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1693    data_sensitivity:
   1694      - technical
   1695    notification_emails:
   1696      - anicholson@mozilla.com
   1697      - chutten@mozilla.com
   1698      - mmccorquodale@mozilla.com
   1699      - najiang@mozilla.com
   1700      - lina@mozilla.com
   1701    expires: never
   1702    send_in_pings:
   1703      - newtab
   1704 
   1705  sponsored_stories_enabled:
   1706    lifetime: application
   1707    type: boolean
   1708    description: >
   1709      Whether Pocket sponsored stories are enabled on the newtab.
   1710      Corresponds to the value of the
   1711      `browser.newtabpage.activity-stream.showSponsored` pref.
   1712      Can be `true` even if pocket.enabled is `false`.
   1713    bugs:
   1714      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1715      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1716    data_reviews:
   1717      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1718      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1719    data_sensitivity:
   1720      - technical
   1721    notification_emails:
   1722      - anicholson@mozilla.com
   1723      - chutten@mozilla.com
   1724      - mmccorquodale@mozilla.com
   1725      - najiang@mozilla.com
   1726      - lina@mozilla.com
   1727    expires: never
   1728    send_in_pings:
   1729      - newtab
   1730 
   1731  impression:
   1732    type: event
   1733    description: >
   1734      Recorded when a pocket tile is visible to the user.
   1735    bugs:
   1736      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1737      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1738      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854245
   1739      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862670
   1740      - https://bugzilla.mozilla.org/show_bug.cgi?id=1937200
   1741    data_reviews:
   1742      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1743      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1744      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854245
   1745    data_sensitivity:
   1746      - interaction
   1747    notification_emails:
   1748      - anicholson@mozilla.com
   1749      - chutten@mozilla.com
   1750      - mmccorquodale@mozilla.com
   1751      - najiang@mozilla.com
   1752      - lina@mozilla.com
   1753      - sdowne@mozilla.com
   1754    expires: never
   1755    extra_keys:
   1756      newtab_visit_id: *newtab_visit_id
   1757      is_sponsored: &is_sponsored_pocket
   1758        description: Whether the pocket tile was sponsored (has an ad callback).
   1759        type: boolean
   1760      format: &format
   1761        description: The format of whatever item is displayed. It can differ if the content is an ad or organic. Possible responses are "spoc", "rectangle" (for ads) "billboard", "leaderboard", "small-card",  "medium-card",  "large-card" (for organic content).
   1762        type: string
   1763      position: &pocket_position
   1764        description: The position (0-index) of the pocket tile.
   1765        type: quantity
   1766      recommendation_id: &recommendation_id
   1767        description: >
   1768          The id from the Pocket API response that returned the recommendation.
   1769          Like "{61934fe5-fbb0-4f4e-b9dd-7eab5f6ee9cd}".
   1770        type: string
   1771      tile_id: &pocket_tile_id
   1772        description: >
   1773          A content identifier.
   1774          For organic Pocket recommendations it is an opaque id produced by
   1775          Pocket's recommendation systems.
   1776          For sponsored Pocket content it is Kevel's "ad ID".
   1777        type: quantity
   1778      scheduled_corpus_item_id: &scheduled_corpus_item_id
   1779        description: >
   1780          A content identifier.
   1781          For organic Newtab recommendations it is an opaque id produced by
   1782          Newtab's recommendation systems that corresponds uniquely to
   1783          a piece of content scheduled for a specific day on a specific surface.
   1784          This is the replacement for tile_id.
   1785        type: string
   1786      corpus_item_id: &corpus_item_id
   1787        description: >
   1788          A content identifier.
   1789          For organic Newtab recommendations it is an opaque id produced by
   1790          Newtab's recommendation systems that corresponds uniquely to the URL.
   1791          This is the replacement for tile_id and scheduled_corpus_item_id.
   1792        type: string
   1793      received_rank: &received_rank
   1794        description: The rank or order of the recommendation at the time it was sent to the client.
   1795        type: quantity
   1796      recommended_at: &recommended_at
   1797        description: The time in milliseconds the recomendation was recommended at.
   1798        type: quantity
   1799      topic:
   1800        description: The topic of the recommendation. Like "entertainment".
   1801        type: string
   1802      selected_topics:
   1803        description: >
   1804          The list of topics the user selected
   1805        type: string
   1806      section:
   1807        description: >
   1808          If click belongs in a section, the name of the section
   1809        type: string
   1810      section_position:
   1811        description: >
   1812          If click belongs in a section, the numeric position of the section
   1813        type: string
   1814      is_section_followed: *is_section_followed
   1815      layout_name: *layout_name
   1816      content_redacted:
   1817        description: >
   1818          Are content details sent separately in the newtab_content ping
   1819        type: boolean
   1820    send_in_pings:
   1821      - newtab
   1822 
   1823  click:
   1824    type: event
   1825    description: >
   1826      Recorded when a pocket tile is clicked.
   1827      Only happens on click. Not on middle-click. Not on "Open in new Tab"-like
   1828      options in the context menu.
   1829    bugs:
   1830      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1831      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1832      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854245
   1833      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862670
   1834      - https://bugzilla.mozilla.org/show_bug.cgi?id=1937200
   1835    data_reviews:
   1836      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1837      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1838      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854245
   1839    data_sensitivity:
   1840      - interaction
   1841    notification_emails:
   1842      - anicholson@mozilla.com
   1843      - chutten@mozilla.com
   1844      - mmccorquodale@mozilla.com
   1845      - najiang@mozilla.com
   1846      - lina@mozilla.com
   1847      - sdowne@mozilla.com
   1848      - mcrawford@mozilla.ccocm
   1849    expires: never
   1850    extra_keys:
   1851      newtab_visit_id: *newtab_visit_id
   1852      is_sponsored: *is_sponsored_pocket
   1853      format: *format
   1854      position: *pocket_position
   1855      recommendation_id: *recommendation_id
   1856      tile_id: *pocket_tile_id
   1857      scheduled_corpus_item_id: *scheduled_corpus_item_id
   1858      corpus_item_id: *corpus_item_id
   1859      received_rank: *received_rank
   1860      recommended_at: *recommended_at
   1861      matches_selected_topic:
   1862        description: >
   1863          Returns value based on if a the topic of the pocket recommendation matches one
   1864          of the user-selected topic categories
   1865        type: string
   1866      topic:
   1867        description: The topic of the recommendation. Like "entertainment".
   1868        type: string
   1869      selected_topics:
   1870        description: >
   1871          The list of topics the user selected
   1872        type: string
   1873      section:
   1874        description: >
   1875          If click belongs in a section, the name of the section
   1876        type: string
   1877      section_position:
   1878        description: >
   1879          If click belongs in a section, the numeric position of the section
   1880        type: string
   1881      is_section_followed: *is_section_followed
   1882      layout_name: *layout_name
   1883      event_source: *event_source
   1884      content_redacted:
   1885        description: >
   1886          Are content details sent separately in the newtab_content ping
   1887        type: boolean
   1888    send_in_pings:
   1889      - newtab
   1890 
   1891  dismiss:
   1892    type: event
   1893    description: >
   1894      Recorded when a pocket tile is dismissed.
   1895    bugs:
   1896      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1897      - https://bugzilla.mozilla.org/show_bug.cgi?id=1937200
   1898    data_reviews:
   1899      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1900    data_sensitivity:
   1901      - interaction
   1902    notification_emails:
   1903      - sdowne@mozilla.com
   1904      - mcrawford@mozilla.com
   1905    expires: never
   1906    extra_keys:
   1907      newtab_visit_id: *newtab_visit_id
   1908      is_sponsored: *is_sponsored_pocket
   1909      format: *format
   1910      position: *pocket_position
   1911      recommendation_id: *recommendation_id
   1912      tile_id: *pocket_tile_id
   1913      scheduled_corpus_item_id: *scheduled_corpus_item_id
   1914      corpus_item_id: *corpus_item_id
   1915      received_rank: *received_rank
   1916      recommended_at: *recommended_at
   1917      section:
   1918        description: >
   1919          If click belongs in a section, the name of the section
   1920        type: string
   1921      section_position:
   1922        description: >
   1923          If click belongs in a section, the numeric position of the section
   1924        type: string
   1925      is_section_followed: *is_section_followed
   1926      content_redacted:
   1927        description: >
   1928          Are content details sent separately in the newtab_content ping
   1929        type: boolean
   1930    send_in_pings:
   1931      - newtab
   1932 
   1933  save:
   1934    type: event
   1935    description: >
   1936      Recorded when a user decides to save a pocket tile.
   1937      Does not mean it ends up successfully saved.
   1938      Just that the user clicked on "Save to Pocket" in the little pocket
   1939      tile menu.
   1940    bugs:
   1941      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1942      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   1943      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854245
   1944      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862670
   1945      - https://bugzilla.mozilla.org/show_bug.cgi?id=1937200
   1946    data_reviews:
   1947      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   1948      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   1949      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854245
   1950    data_sensitivity:
   1951      - interaction
   1952    notification_emails:
   1953      - anicholson@mozilla.com
   1954      - chutten@mozilla.com
   1955      - mmccorquodale@mozilla.com
   1956      - najiang@mozilla.com
   1957      - lina@mozilla.com
   1958      - mcrawford@mozilla.com
   1959    expires: never
   1960    extra_keys:
   1961      newtab_visit_id: *newtab_visit_id
   1962      is_sponsored: *is_sponsored_pocket
   1963      format: *format
   1964      position: *pocket_position
   1965      recommendation_id: *recommendation_id
   1966      tile_id: *pocket_tile_id
   1967      scheduled_corpus_item_id: *scheduled_corpus_item_id
   1968      corpus_item_id: *corpus_item_id
   1969      received_rank: *received_rank
   1970      recommended_at: *recommended_at
   1971      topic:
   1972        description: The topic of the recommendation. Like "entertainment".
   1973        type: string
   1974      matches_selected_topic:
   1975        description: >
   1976          Returns value based on if a the topic of the pocket recommendation matches one
   1977          of the user-selected topic categories
   1978        type: string
   1979      selected_topics:
   1980        description: >
   1981          The list of topics the user selected
   1982        type: string
   1983      section:
   1984        description: >
   1985          If click belongs in a section, the name of the section
   1986        type: string
   1987      section_position:
   1988        description: >
   1989          If click belongs in a section, the numeric position of the section
   1990        type: string
   1991      is_section_followed: *is_section_followed
   1992    send_in_pings:
   1993      - newtab
   1994 
   1995  topic_click:
   1996    type: event
   1997    description: >
   1998      Recorded when a pocket "Popular Topic" is clicked.
   1999      Only happens on click. Not on middle-click. Not on "Open in new Tab"-like
   2000      options in the context menu.
   2001    bugs:
   2002      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   2003      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   2004      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854245
   2005    data_reviews:
   2006      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   2007      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   2008      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854245
   2009    data_sensitivity:
   2010      - interaction
   2011    notification_emails:
   2012      - anicholson@mozilla.com
   2013      - chutten@mozilla.com
   2014      - mmccorquodale@mozilla.com
   2015      - najiang@mozilla.com
   2016      - lina@mozilla.com
   2017    expires: never
   2018    extra_keys:
   2019      newtab_visit_id: *newtab_visit_id
   2020      topic:
   2021        description: The topic that was clicked on. Like "entertainment".
   2022        type: string
   2023    send_in_pings:
   2024      - newtab
   2025 
   2026  spoc_placeholder_duration:
   2027      type: timing_distribution
   2028      time_unit: millisecond
   2029      description: >
   2030        Time in milliseconds that a placeholder for a sponsored story (spoc) is
   2031        visible to the user before being replaced with actual sponsored content.
   2032        This measures how long users see loading placeholders when spocs need to
   2033        be fetched, which can happen during startup, cache expiration, or other
   2034        loading scenarios.
   2035      bugs:
   2036        - https://bugzilla.mozilla.org/show_bug.cgi?id=1993586
   2037      data_reviews:
   2038        - https://bugzilla.mozilla.org/show_bug.cgi?id=1993586
   2039      data_sensitivity:
   2040        - technical
   2041      notification_emails:
   2042        - mcrawford@mozilla.com
   2043      expires: never
   2044      send_in_pings:
   2045        - newtab
   2046 
   2047 
   2048  shim:
   2049    type: text
   2050    lifetime: ping
   2051    description: |
   2052      Opaque partner identifier for a given ad impression or engagement action,
   2053      unique per market and region.
   2054      Pocket
   2055      [proxies requests to ad partners](https://github.com/Pocket/proxy-server/)
   2056      and provides them solely with market, region, and action to generate these
   2057      shims. Thus, though the contents of this field are obscure, they cannot
   2058      identify clients.
   2059      At time of writing this information is a comma-separated trio.
   2060      The first item is an index into the proxy server's list of acceptable http
   2061      endpoints for contacting the ad service. The second item is a
   2062      several-hundred-byte base64-encoded JSON-encoded struct with fields for,
   2063      amongst other things, market and region. The third is unknown, but appears
   2064      to be a signature or checksum.
   2065      This shim should not be sent with the client_id.
   2066    bugs:
   2067      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862670
   2068    data_reviews:
   2069      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862670
   2070    data_sensitivity:
   2071      - stored_content # Required for text type, and to encourage scrutiny
   2072    notification_emails:
   2073      - chutten@mozilla.com
   2074      - najiang@mozilla.com
   2075    expires: never
   2076    send_in_pings:
   2077      - spoc
   2078 
   2079  fetch_timestamp:
   2080    type: datetime
   2081    lifetime: ping
   2082    description: |
   2083      Timestamp of when the spoc was fetched by the client
   2084    bugs:
   2085      - https://bugzilla.mozilla.org/show_bug.cgi?id=1887655
   2086    data_reviews:
   2087      - https://bugzilla.mozilla.org/show_bug.cgi?id=1887655
   2088    notification_emails:
   2089      - dmueller@mozilla.com
   2090    expires: never
   2091    send_in_pings:
   2092      - spoc
   2093 
   2094  newtab_creation_timestamp:
   2095    type: datetime
   2096    lifetime: ping
   2097    description: |
   2098      Timestamp of when this instance of the newtab was first visible to the user.
   2099    bugs:
   2100      - https://bugzilla.mozilla.org/show_bug.cgi?id=1887655
   2101    data_reviews:
   2102      - https://bugzilla.mozilla.org/show_bug.cgi?id=1887655
   2103    notification_emails:
   2104      - dmueller@mozilla.com
   2105    expires: never
   2106    send_in_pings:
   2107      - spoc
   2108 
   2109 newtab_content:
   2110 
   2111  experiment_name:
   2112    type: string
   2113    description: >
   2114      The name of the primary new tab content experiment. We don't include all experiments to prevent user fingerprinting.
   2115    bugs:
   2116      - https://bugzilla.mozilla.org/show_bug.cgi?id=1966796
   2117    data_reviews:
   2118      - https://bugzilla.mozilla.org/show_bug.cgi?id=1966796
   2119    data_sensitivity:
   2120      - technical
   2121    notification_emails:
   2122      - nbarrett@mozilla.com
   2123    expires: never
   2124    lifetime: application
   2125    send_in_pings:
   2126      - newtab-content
   2127 
   2128  experiment_branch:
   2129    type: string
   2130    description: >
   2131      The branch of the primary new tab content experiment. We don't include all experiments to prevent user fingerprinting.
   2132    bugs:
   2133      - https://bugzilla.mozilla.org/show_bug.cgi?id=1966796
   2134    data_reviews:
   2135      - https://bugzilla.mozilla.org/show_bug.cgi?id=1966796
   2136    data_sensitivity:
   2137      - technical
   2138    notification_emails:
   2139      - nbarrett@mozilla.com
   2140    expires: never
   2141    lifetime: application
   2142    send_in_pings:
   2143      - newtab-content
   2144 
   2145  inferred_interests:
   2146    type: object
   2147    description: >
   2148      Differentially private high-level inferred interests (e.g. Entertainment or News), encoded in a JSON string.
   2149      Key is the feature, and the value is a unary encoded string that must be decoded based on known differential
   2150      privacy q and p values. Example "{"arts":"001"}"
   2151    bugs:
   2152      - https://bugzilla.mozilla.org/show_bug.cgi?id=1966796
   2153    data_reviews:
   2154      - https://bugzilla.mozilla.org/show_bug.cgi?id=1966796
   2155    data_sensitivity:
   2156      - technical
   2157    notification_emails:
   2158      - nbarrett@mozilla.com
   2159    expires: never
   2160    lifetime: application
   2161    send_in_pings:
   2162      - newtab-content
   2163    structure:
   2164      type: object
   2165      properties:
   2166        values:
   2167          type: array
   2168          items:
   2169            type: string
   2170        model_id:
   2171          type: string
   2172 
   2173  ping_version:
   2174    type: quantity
   2175    description: >
   2176      Marks major revisions of data collection methods or format for this ping. Because we are not recording Firefox version,
   2177      this field has been added to assist the data pipeline. To avoid user possible fingerprinting, this should be updated only when
   2178      necessary.
   2179    bugs:
   2180      - https://bugzilla.mozilla.org/show_bug.cgi?id=1980022
   2181    data_reviews:
   2182      - https://bugzilla.mozilla.org/show_bug.cgi?id=1980022
   2183    data_sensitivity:
   2184      - technical
   2185    notification_emails:
   2186      - nbarrett@mozilla.com
   2187      - rrando@mozilla.com
   2188    expires: never
   2189    send_in_pings:
   2190      - newtab-content
   2191    lifetime: application
   2192    unit: version number
   2193 
   2194 
   2195 
   2196  coarse_os:
   2197    type: string
   2198    description: >
   2199      The name of the operating system. Possible values:
   2200      Android, iOS, Linux, Windows, or macOS
   2201    bugs:
   2202      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956331
   2203    data_reviews:
   2204      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956331
   2205    data_sensitivity:
   2206      - technical
   2207    notification_emails:
   2208      - nbarrett@mozilla.com
   2209    expires: never
   2210    lifetime: application
   2211    send_in_pings:
   2212      - newtab-content
   2213 
   2214  utc_offset:
   2215    type: quantity
   2216    description: >
   2217      <0-24> positive UTC offset, rounded to the nearest integer number greater than 0.
   2218      (If less than 0, then add 24.). The value may be clamped by expected time zone ranges for a surface.
   2219    bugs:
   2220      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956331
   2221    data_reviews:
   2222      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956331
   2223    data_sensitivity:
   2224      - technical
   2225    notification_emails:
   2226      - nbarrett@mozilla.com
   2227    expires: never
   2228    send_in_pings:
   2229      - newtab-content
   2230    lifetime: application
   2231    unit: utc offset
   2232 
   2233  country:
   2234    type: string
   2235    description: >
   2236      Records the detected home region of the user. This is the general region
   2237      of the user's machine.
   2238 
   2239      If a machine moves location, there is a minimum 2-week delay before this
   2240      will be updated.
   2241 
   2242      See the [Region documentation](https://firefox-source-docs.mozilla.org/toolkit/modules/toolkit_modules/Region.html)
   2243      for more information about updates.
   2244    bugs:
   2245      - https://bugzilla.mozilla.org/show_bug.cgi?id=1964428
   2246    data_reviews:
   2247      - https://bugzilla.mozilla.org/show_bug.cgi?id=1964428
   2248    data_sensitivity:
   2249      - technical
   2250    notification_emails:
   2251      - nbarrett@mozilla.com
   2252    expires: never
   2253    send_in_pings:
   2254      - newtab-content
   2255    lifetime: application
   2256 
   2257  surface_id:
   2258    type: string
   2259    description: >
   2260      Surface id sent to the client from merino api
   2261    bugs:
   2262      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956331
   2263    data_reviews:
   2264      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956331
   2265    data_sensitivity:
   2266      - technical
   2267    notification_emails:
   2268      - nbarrett@mozilla.com
   2269    expires: never
   2270    send_in_pings:
   2271      - newtab-content
   2272      - newtab
   2273    lifetime: application
   2274 
   2275  followed_sections:
   2276    type: string_list
   2277    description: >
   2278      Optional metric: section ids followed by user in alphabetical order, if possible,
   2279      ordered by most recently followed. Max 2 sections
   2280    bugs:
   2281      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956331
   2282    data_reviews:
   2283      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956331
   2284    data_sensitivity:
   2285      - interaction
   2286    notification_emails:
   2287      - nbarrett@mozilla.com
   2288    expires: never
   2289    send_in_pings:
   2290      - newtab-content
   2291    lifetime: application
   2292 
   2293 
   2294  impression:
   2295    type: event
   2296    description: >
   2297      Recorded when a pocket tile is visible to the user.
   2298    bugs:
   2299      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   2300      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
   2301      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854245
   2302      - https://bugzilla.mozilla.org/show_bug.cgi?id=1862670
   2303      - https://bugzilla.mozilla.org/show_bug.cgi?id=1937200
   2304    data_reviews:
   2305      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   2306      - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
   2307      - https://bugzilla.mozilla.org/show_bug.cgi?id=1854245
   2308    data_sensitivity:
   2309      - interaction
   2310    notification_emails:
   2311      - anicholson@mozilla.com
   2312      - chutten@mozilla.com
   2313      - mmccorquodale@mozilla.com
   2314      - najiang@mozilla.com
   2315      - lina@mozilla.com
   2316      - sdowne@mozilla.com
   2317    expires: never
   2318    extra_keys:
   2319      is_sponsored: *is_sponsored_pocket
   2320      format: *format
   2321      position: *pocket_position
   2322      recommendation_id: *recommendation_id
   2323      tile_id: *pocket_tile_id
   2324      scheduled_corpus_item_id: *scheduled_corpus_item_id
   2325      corpus_item_id: *corpus_item_id
   2326      received_rank: *received_rank
   2327      recommended_at: *recommended_at
   2328      topic:
   2329        description: The topic of the recommendation. Like "entertainment".
   2330        type: string
   2331      selected_topics:
   2332        description: >
   2333          The list of topics the user selected
   2334        type: string
   2335      section:
   2336        description: >
   2337          If click belongs in a section, the name of the section
   2338        type: string
   2339      section_position:
   2340        description: >
   2341          If click belongs in a section, the numberic position of the section
   2342        type: string
   2343      is_section_followed:
   2344        description: >
   2345          If click belongs in a section, if that section is followed
   2346        type: boolean
   2347    send_in_pings:
   2348      - newtab-content
   2349 
   2350  click:
   2351    type: event
   2352    description: >
   2353      Recorded when a pocket tile is clicked.
   2354      Only happens on click. Not on middle-click. Not on "Open in new Tab"-like
   2355      options in the context menu.
   2356    bugs:
   2357      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956331
   2358    data_reviews:
   2359      - https://bugzilla.mozilla.org/show_bug.cgi?id=1956331
   2360    data_sensitivity:
   2361      - interaction
   2362    notification_emails:
   2363      - mcrawford@mozilla.cocm
   2364    expires: never
   2365    extra_keys:
   2366      is_sponsored: *is_sponsored_pocket
   2367      format: *format
   2368      position: *pocket_position
   2369      recommendation_id: *recommendation_id
   2370      tile_id: *pocket_tile_id
   2371      scheduled_corpus_item_id: *scheduled_corpus_item_id
   2372      corpus_item_id: *corpus_item_id
   2373      received_rank: *received_rank
   2374      recommended_at: *recommended_at
   2375      matches_selected_topic:
   2376        description: >
   2377          Returns value based on if a the topic of the pocket recommendation matches one
   2378          of the user-selected topic categories
   2379        type: string
   2380      topic:
   2381        description: The topic of the recommendation. Like "entertainment".
   2382        type: string
   2383      selected_topics:
   2384        description: >
   2385          The list of topics the user selected
   2386        type: string
   2387      section:
   2388        description: >
   2389          If click belongs in a section, the name of the section
   2390        type: string
   2391      section_position:
   2392        description: >
   2393          If click belongs in a section, the numberic position of the section
   2394        type: string
   2395      is_section_followed:
   2396        description: >
   2397          If click belongs in a section, if that section is followed
   2398        type: boolean
   2399    send_in_pings:
   2400      - newtab-content
   2401 
   2402  dismiss:
   2403    type: event
   2404    description: >
   2405      Recorded when a pocket tile is dismissed.
   2406    bugs:
   2407      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   2408      - https://bugzilla.mozilla.org/show_bug.cgi?id=1937200
   2409    data_reviews:
   2410      - https://bugzilla.mozilla.org/show_bug.cgi?id=1786612
   2411    data_sensitivity:
   2412      - interaction
   2413    notification_emails:
   2414      - sdowne@mozilla.com
   2415      - mcrawford@mozilla.com
   2416    expires: never
   2417    extra_keys:
   2418      is_sponsored: *is_sponsored_pocket
   2419      format: *format
   2420      position: *pocket_position
   2421      recommendation_id: *recommendation_id
   2422      tile_id: *pocket_tile_id
   2423      scheduled_corpus_item_id: *scheduled_corpus_item_id
   2424      corpus_item_id: *corpus_item_id
   2425      received_rank: *received_rank
   2426      recommended_at: *recommended_at
   2427      section:
   2428        description: >
   2429          If click belongs in a section, the name of the section
   2430        type: string
   2431      section_position:
   2432        description: >
   2433          If click belongs in a section, the numberic position of the section
   2434        type: string
   2435      is_section_followed:
   2436        description: >
   2437          If click belongs in a section, if that section is followed
   2438        type: boolean
   2439    send_in_pings:
   2440      - newtab-content
   2441 
   2442  sections_impression:
   2443    type: event
   2444    description: >
   2445      Recorded when a section is viewport and triggers an impression event
   2446    bugs:
   2447      - https://bugzilla.mozilla.org/show_bug.cgi?id=1927916
   2448      - https://bugzilla.mozilla.org/show_bug.cgi?id=1938215
   2449    data_reviews:
   2450      - https://bugzilla.mozilla.org/show_bug.cgi?id=1927916
   2451    data_sensitivity:
   2452      - interaction
   2453    notification_emails:
   2454      - nbarrett@mozilla.com
   2455      - mcrawford@mozilla.com
   2456    expires: never
   2457    extra_keys:
   2458      section:
   2459        description: >
   2460          section that had impression event
   2461        type: string
   2462      section_position:
   2463        description: >
   2464          position of section on newtab
   2465        type: string
   2466      is_section_followed:
   2467        description: >
   2468          If click belongs in a section, if that section is followed
   2469        type: boolean
   2470      layout_name: *layout_name
   2471    send_in_pings:
   2472      - newtab-content
   2473 
   2474  sections_follow_section:
   2475    type: event
   2476    description: >
   2477      Recorded when a section is followed
   2478    bugs:
   2479      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
   2480    data_reviews:
   2481      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
   2482    data_sensitivity:
   2483      - interaction
   2484    notification_emails:
   2485      - mcrawford@mozilla.com
   2486    expires: never
   2487    extra_keys:
   2488      section:
   2489        description: >
   2490          section that had impression event
   2491        type: string
   2492      section_position:
   2493        description: >
   2494          position of section on newtab
   2495        type: string
   2496      event_source: *event_source
   2497    send_in_pings:
   2498      - newtab-content
   2499 
   2500  sections_unfollow_section:
   2501    type: event
   2502    description: >
   2503      Recorded when a section is unfollowed
   2504    bugs:
   2505      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
   2506    data_reviews:
   2507      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
   2508    data_sensitivity:
   2509      - interaction
   2510    notification_emails:
   2511      - mcrawford@mozilla.com
   2512    expires: never
   2513    extra_keys:
   2514      section:
   2515        description: >
   2516          section that had impression event
   2517        type: string
   2518      section_position:
   2519        description: >
   2520          position of section on newtab
   2521        type: string
   2522      event_source: *event_source
   2523    send_in_pings:
   2524      - newtab-content
   2525 
   2526  sections_block_section:
   2527    type: event
   2528    description: >
   2529      Recorded when a section is blocked
   2530    bugs:
   2531      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
   2532    data_reviews:
   2533      - https://bugzilla.mozilla.org/show_bug.cgi?id=1932191
   2534    data_sensitivity:
   2535      - interaction
   2536    notification_emails:
   2537      - mcrawford@mozilla.com
   2538    expires: never
   2539    extra_keys:
   2540      section:
   2541        description: >
   2542          section that had impression event
   2543        type: string
   2544      section_position:
   2545        description: >
   2546          position of section on newtab
   2547        type: string
   2548      event_source: *event_source
   2549    send_in_pings:
   2550      - newtab-content
   2551 
   2552  sections_unblock_section:
   2553    type: event
   2554    description: >
   2555      Recorded when a section is unblocked
   2556    bugs:
   2557      - https://bugzilla.mozilla.org/show_bug.cgi?id=1940566
   2558    data_reviews:
   2559      - https://bugzilla.mozilla.org/show_bug.cgi?id=1940566
   2560    data_sensitivity:
   2561      - interaction
   2562    notification_emails:
   2563      - mcrawford@mozilla.com
   2564    expires: never
   2565    extra_keys:
   2566      section:
   2567        description: >
   2568          section that had unblock event
   2569        type: string
   2570      section_position:
   2571        description: >
   2572          position of section on newtab
   2573        type: string
   2574      event_source: *event_source
   2575    send_in_pings:
   2576      - newtab-content
   2577 
   2578  report_content_open:
   2579    type: event
   2580    description: >
   2581      Recorded when content reporting is opened from context menu
   2582    bugs:
   2583      - https://bugzilla.mozilla.org/show_bug.cgi?id=1954656
   2584    data_reviews:
   2585      - https://bugzilla.mozilla.org/show_bug.cgi?id=1954656
   2586    data_sensitivity:
   2587      - interaction
   2588    notification_emails:
   2589      - rhamoui@mozilla.com
   2590    expires: never
   2591    extra_keys:
   2592      corpus_item_id: *corpus_item_id
   2593      scheduled_corpus_item_id: *scheduled_corpus_item_id
   2594    send_in_pings:
   2595      - newtab-content
   2596 
   2597  report_content_submit:
   2598    type: event
   2599    description: >
   2600      Recorded when content reporting has been submitted
   2601    bugs:
   2602      - https://bugzilla.mozilla.org/show_bug.cgi?id=1954656
   2603    data_reviews:
   2604      - https://bugzilla.mozilla.org/show_bug.cgi?id=1954656
   2605    data_sensitivity:
   2606      - interaction
   2607      - web_activity
   2608    notification_emails:
   2609      - rhamoui@mozilla.com
   2610    expires: never
   2611    extra_keys:
   2612      card_type:
   2613        description: >
   2614          The type of the content card (e.g., "spoc", "organic")
   2615        type: string
   2616      corpus_item_id: *corpus_item_id
   2617      report_reason:
   2618        description: >
   2619          The reason selected by the user when reporting the content
   2620        type: string
   2621      scheduled_corpus_item_id: *scheduled_corpus_item_id
   2622      section:
   2623        description: >
   2624          If click belongs in a section, the name of the section
   2625        type: string
   2626      section_position:
   2627        description: >
   2628          If click belongs in a section, the numeric position of the section
   2629        type: string
   2630      title:
   2631        description: >
   2632          Title of the recommendation.
   2633        type: string
   2634      topic:
   2635        description: >
   2636          The topic of the recommendation. Like "entertainment".
   2637        type: string
   2638      url:
   2639        description: >
   2640          URL of the recommendation.
   2641        type: string
   2642    send_in_pings:
   2643      - newtab-content
   2644    no_lint:
   2645      - HIGHER_DATA_SENSITIVITY_REQUIRED
   2646 
   2647  top_sites_click:
   2648    type: event
   2649    description: >
   2650      Recorded when a top sites tile is clicked.
   2651    bugs:
   2652      - https://bugzilla.mozilla.org/show_bug.cgi?id=2003048
   2653    data_reviews:
   2654      - https://bugzilla.mozilla.org/show_bug.cgi?id=2003048
   2655    data_sensitivity:
   2656      - interaction
   2657    notification_emails:
   2658      - nbarrett@mozilla.com
   2659      - sdowne@mozilla.com
   2660    expires: never
   2661    extra_keys:
   2662      advertiser_name: *advertiser_name
   2663      tile_id: *tile_id
   2664      is_sponsored: *is_sponsored
   2665      position: *topsite_position
   2666      visible_topsites: *visible_topsites
   2667      frecency_boosted: &frecency_boosted
   2668        description: >
   2669          Whether the top site was frecency boosted
   2670        type: boolean
   2671      frecency_boosted_has_exposure: &frecency_boosted_has_exposure
   2672        description: >
   2673          Whether the user had the option to see frecency boosted shortcuts
   2674        type: boolean
   2675    send_in_pings:
   2676      - newtab-content
   2677 
   2678  top_sites_impression:
   2679    type: event
   2680    description: >
   2681      Recorded when a top sites tile is visible to the user.
   2682    bugs:
   2683      - https://bugzilla.mozilla.org/show_bug.cgi?id=2003048
   2684    data_reviews:
   2685      - https://bugzilla.mozilla.org/show_bug.cgi?id=2003048
   2686    data_sensitivity:
   2687      - interaction
   2688    notification_emails:
   2689      - nbarrett@mozilla.com
   2690      - sdowne@mozilla.com
   2691    expires: never
   2692    extra_keys:
   2693      advertiser_name: *advertiser_name
   2694      tile_id: *tile_id
   2695      is_sponsored: *is_sponsored
   2696      position: *topsite_position
   2697      visible_topsites: *visible_topsites
   2698      frecency_boosted: *frecency_boosted
   2699      frecency_boosted_has_exposure: *frecency_boosted_has_exposure
   2700    send_in_pings:
   2701      - newtab-content
   2702 
   2703  top_sites_dismiss:
   2704    type: event
   2705    description: >
   2706      Recorded when the "Dismiss" menu item in the three-dots menu of a topsite
   2707      is clicked.
   2708    bugs:
   2709      - https://bugzilla.mozilla.org/show_bug.cgi?id=2003048
   2710    data_reviews:
   2711      - https://bugzilla.mozilla.org/show_bug.cgi?id=2003048
   2712    data_sensitivity:
   2713      - interaction
   2714    notification_emails:
   2715      - nbarrett@mozilla.com
   2716      - sdowne@mozilla.com
   2717    expires: never
   2718    extra_keys:
   2719      advertiser_name: *advertiser_name
   2720      tile_id: *tile_id
   2721      is_sponsored: *is_sponsored
   2722      position: *topsite_position
   2723    send_in_pings:
   2724      - newtab-content
   2725 
   2726  top_sites_show_privacy_click:
   2727    type: event
   2728    description: >
   2729      Recorded when the "Our sponsors & your privacy" menu item in the three-dots menu of a topsite
   2730      is clicked.
   2731    bugs:
   2732      - https://bugzilla.mozilla.org/show_bug.cgi?id=2003048
   2733    data_reviews:
   2734      - https://bugzilla.mozilla.org/show_bug.cgi?id=2003048
   2735    data_sensitivity:
   2736      - interaction
   2737    notification_emails:
   2738      - nbarrett@mozilla.com
   2739      - sdowne@mozilla.com
   2740    expires: never
   2741    extra_keys:
   2742      advertiser_name: *advertiser_name
   2743      tile_id: *tile_id
   2744      position: *topsite_position
   2745    send_in_pings:
   2746      - newtab-content
   2747 
   2748 top_sites: # Replacement for PingCentre "topsites-impression|click" pings.
   2749  ping_type:
   2750    type: string
   2751    description: >
   2752      The ping's type. In other situations might be designated by an event's
   2753      name or an interaction field. E.g. "topsites-impression",
   2754      "topsites-click".
   2755    bugs:
   2756      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2757    data_reviews:
   2758      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2759    data_sensitivity:
   2760      - interaction
   2761    notification_emails:
   2762      - najiang@mozilla.com
   2763    expires: never
   2764    send_in_pings:
   2765      - top-sites
   2766 
   2767  position:
   2768    type: quantity
   2769    unit: topsite position
   2770    description: >
   2771      The position (1-based) of the topsites item being interatcted with.
   2772    bugs:
   2773      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2774    data_reviews:
   2775      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2776    data_sensitivity:
   2777      - interaction
   2778    notification_emails:
   2779      - najiang@mozilla.com
   2780    expires: never
   2781    send_in_pings:
   2782      - top-sites
   2783 
   2784  source:
   2785    type: string
   2786    description: >
   2787      The source of the interaction. Always set to "newtab".
   2788    bugs:
   2789      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2790    data_reviews:
   2791      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2792    data_sensitivity:
   2793      - interaction
   2794    notification_emails:
   2795      - najiang@mozilla.com
   2796    expires: never
   2797    send_in_pings:
   2798      - top-sites
   2799 
   2800  tile_id:
   2801    type: string
   2802    description: >
   2803      String-encoded number for the tile's sponsored tile id.
   2804    bugs:
   2805      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2806    data_reviews:
   2807      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2808    data_sensitivity:
   2809      - interaction
   2810    notification_emails:
   2811      - najiang@mozilla.com
   2812    expires: never
   2813    send_in_pings:
   2814      - top-sites
   2815 
   2816  reporting_url:
   2817    type: url
   2818    description: >
   2819      The url to report this interaction to.
   2820    bugs:
   2821      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2822    data_reviews:
   2823      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2824    data_sensitivity:
   2825      - web_activity
   2826    notification_emails:
   2827      - najiang@mozilla.com
   2828    expires: never
   2829    send_in_pings:
   2830      - top-sites
   2831 
   2832  advertiser:
   2833    type: string
   2834    description: >
   2835      The name of the advertiser providing the sponsored TopSite.
   2836    bugs:
   2837      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2838    data_reviews:
   2839      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2840    data_sensitivity:
   2841      - interaction
   2842      - web_activity
   2843    notification_emails:
   2844      - najiang@mozilla.com
   2845    expires: never
   2846    send_in_pings:
   2847      - top-sites
   2848 
   2849  context_id:
   2850    type: uuid
   2851    description: >
   2852      An identifier to identify users for Contextual Services user interaction pings.
   2853    bugs:
   2854      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2855    data_reviews:
   2856      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
   2857    data_sensitivity:
   2858      - technical
   2859    notification_emails:
   2860      - najiang@mozilla.com
   2861    expires: never
   2862    send_in_pings:
   2863      - top-sites
   2864 
   2865 activity_stream:
   2866  end_session:
   2867    type: event
   2868    description: >
   2869      This is recorded with every session ended in Activity Stream.
   2870      This event was generated to correspond to the Legacy Telemetry event
   2871      activity_stream.end#session.
   2872    bugs:
   2873      - https://bugzil.la/1429497
   2874      - https://bugzil.la/1429489
   2875    data_reviews:
   2876      - https://bugzil.la/1429497
   2877      - https://bugzil.la/1429489
   2878    notification_emails:
   2879      - najiang@mozilla.com
   2880      - msamuel@mozilla.com
   2881    expires: never
   2882    extra_keys:
   2883      value:
   2884        description: >
   2885          The session duration. Mirrors to the Legacy Telemetry
   2886          event's `value` parameter.
   2887        type: quantity
   2888      addon_version:
   2889        description: >
   2890          The Activity Stream addon version.
   2891        type: string
   2892      session_id:
   2893        description: >
   2894          The ID of the Activity Stream session in which the event occurred
   2895        type: string
   2896      page:
   2897        description: >
   2898          about:home or about_newtab - the page where the event occurred
   2899        type: string
   2900      user_prefs:
   2901        description: >
   2902          An integer representaing a user's A-S settings.
   2903        type: quantity
   2904    telemetry_mirror: Activity_stream_End_Session
   2905 
   2906  event_block:
   2907    type: event
   2908    description: >
   2909      This is recorded with every user interaction on Activity Stream
   2910      elements.
   2911      This event was generated to correspond to the Legacy Telemetry event
   2912      activity_stream.event#BLOCK.
   2913    bugs: &activity_stream_event_bugs
   2914      - https://bugzil.la/1429497
   2915      - https://bugzil.la/1429489
   2916      - https://bugzil.la/1514732
   2917    data_reviews: &activity_stream_event_data_reviews
   2918      - https://bugzil.la/1429497
   2919      - https://bugzil.la/1429489
   2920      - https://bugzil.la/1514732
   2921    notification_emails: &activity_stream_event_emails
   2922      - najiang@mozilla.com
   2923      - msamuel@mozilla.com
   2924      - rrosario@mozilla.com
   2925    expires: never
   2926    extra_keys: &activity_stream_event_extra
   2927      value:
   2928        description: >
   2929          The `value` of the event. Mirrors to the Legacy Telemetry
   2930          event's `value` parameter.
   2931        type: string
   2932      addon_version:
   2933        description: >
   2934          The Activity Stream addon version.
   2935        type: string
   2936      session_id:
   2937        description: >
   2938          The ID of the Activity Stream session in which the event occurred
   2939        type: string
   2940      page:
   2941        description: >
   2942          about:home or about_newtab - the page where the event occurred
   2943        type: string
   2944      user_prefs:
   2945        description: >
   2946          An integer representaing a user's A-S settings.
   2947        type: quantity
   2948      action_position:
   2949        description: >
   2950          The index of card receiving interactions.
   2951        type: quantity
   2952    telemetry_mirror: Activity_stream_Event_Block
   2953 
   2954  event_bookmark_add:
   2955    type: event
   2956    description: >
   2957      This is recorded with every user interaction on Activity Stream
   2958      elements.
   2959      This event was generated to correspond to the Legacy Telemetry event
   2960      activity_stream.event#BOOKMARK_ADD.
   2961    bugs: *activity_stream_event_bugs
   2962    data_reviews: *activity_stream_event_data_reviews
   2963    notification_emails: *activity_stream_event_emails
   2964    expires: never
   2965    extra_keys: *activity_stream_event_extra
   2966    telemetry_mirror: Activity_stream_Event_BookmarkAdd
   2967 
   2968  event_bookmark_delete:
   2969    type: event
   2970    description: >
   2971      This is recorded with every user interaction on Activity Stream
   2972      elements.
   2973      This event was generated to correspond to the Legacy Telemetry event
   2974      activity_stream.event#BOOKMARK_DELETE.
   2975    bugs: *activity_stream_event_bugs
   2976    data_reviews: *activity_stream_event_data_reviews
   2977    notification_emails: *activity_stream_event_emails
   2978    expires: never
   2979    extra_keys: *activity_stream_event_extra
   2980    telemetry_mirror: Activity_stream_Event_BookmarkDelete
   2981 
   2982  event_click:
   2983    type: event
   2984    description: >
   2985      This is recorded with every user interaction on Activity Stream
   2986      elements.
   2987      This event was generated to correspond to the Legacy Telemetry event
   2988      activity_stream.event#CLICK.
   2989    bugs: *activity_stream_event_bugs
   2990    data_reviews: *activity_stream_event_data_reviews
   2991    notification_emails: *activity_stream_event_emails
   2992    expires: never
   2993    extra_keys: *activity_stream_event_extra
   2994    telemetry_mirror: Activity_stream_Event_Click
   2995 
   2996  event_click_privacy_info:
   2997    type: event
   2998    description: >
   2999      This is recorded with every user interaction on Activity Stream
   3000      elements.
   3001      This event was generated to correspond to the Legacy Telemetry event
   3002      activity_stream.event#CLICK_PRIVACY_INFO.
   3003    bugs: *activity_stream_event_bugs
   3004    data_reviews: *activity_stream_event_data_reviews
   3005    notification_emails: *activity_stream_event_emails
   3006    expires: never
   3007    extra_keys: *activity_stream_event_extra
   3008    telemetry_mirror: Activity_stream_Event_ClickPrivacyInfo
   3009 
   3010  event_close_newtab_prefs:
   3011    type: event
   3012    description: >
   3013      This is recorded with every user interaction on Activity Stream
   3014      elements.
   3015      This event was generated to correspond to the Legacy Telemetry event
   3016      activity_stream.event#CLOSE_NEWTAB_PREFS.
   3017    bugs: *activity_stream_event_bugs
   3018    data_reviews: *activity_stream_event_data_reviews
   3019    notification_emails: *activity_stream_event_emails
   3020    expires: never
   3021    extra_keys: *activity_stream_event_extra
   3022    telemetry_mirror: Activity_stream_Event_CloseNewtabPrefs
   3023 
   3024  event_show_personalize:
   3025    type: event
   3026    description: >
   3027      This is recorded with every user interaction on Activity Stream
   3028      elements.
   3029      This event was generated to correspond to the Legacy Telemetry event
   3030      activity_stream.event#SHOW_PERSONALIZE.
   3031    bugs: *activity_stream_event_bugs
   3032    data_reviews: *activity_stream_event_data_reviews
   3033    notification_emails: *activity_stream_event_emails
   3034    expires: never
   3035    extra_keys: *activity_stream_event_extra
   3036    telemetry_mirror: Activity_stream_Event_ShowPersonalize
   3037 
   3038  event_hide_personalize:
   3039    type: event
   3040    description: >
   3041      This is recorded with every user interaction on Activity Stream
   3042      elements.
   3043      This event was generated to correspond to the Legacy Telemetry event
   3044      activity_stream.event#HIDE_PERSONALIZE.
   3045    bugs: *activity_stream_event_bugs
   3046    data_reviews: *activity_stream_event_data_reviews
   3047    notification_emails: *activity_stream_event_emails
   3048    expires: never
   3049    extra_keys: *activity_stream_event_extra
   3050    telemetry_mirror: Activity_stream_Event_HidePersonalize
   3051 
   3052  event_delete:
   3053    type: event
   3054    description: >
   3055      This is recorded with every user interaction on Activity Stream
   3056      elements.
   3057      This event was generated to correspond to the Legacy Telemetry event
   3058      activity_stream.event#DELETE.
   3059    bugs: *activity_stream_event_bugs
   3060    data_reviews: *activity_stream_event_data_reviews
   3061    notification_emails: *activity_stream_event_emails
   3062    expires: never
   3063    extra_keys: *activity_stream_event_extra
   3064    telemetry_mirror: Activity_stream_Event_Delete
   3065 
   3066  event_delete_confirm:
   3067    type: event
   3068    description: >
   3069      This is recorded with every user interaction on Activity Stream
   3070      elements.
   3071      This event was generated to correspond to the Legacy Telemetry event
   3072      activity_stream.event#DELETE_CONFIRM.
   3073    bugs: *activity_stream_event_bugs
   3074    data_reviews: *activity_stream_event_data_reviews
   3075    notification_emails: *activity_stream_event_emails
   3076    expires: never
   3077    extra_keys: *activity_stream_event_extra
   3078    telemetry_mirror: Activity_stream_Event_DeleteConfirm
   3079 
   3080  event_dialog_cancel:
   3081    type: event
   3082    description: >
   3083      This is recorded with every user interaction on Activity Stream
   3084      elements.
   3085      This event was generated to correspond to the Legacy Telemetry event
   3086      activity_stream.event#DIALOG_CANCEL.
   3087    bugs: *activity_stream_event_bugs
   3088    data_reviews: *activity_stream_event_data_reviews
   3089    notification_emails: *activity_stream_event_emails
   3090    expires: never
   3091    extra_keys: *activity_stream_event_extra
   3092    telemetry_mirror: Activity_stream_Event_DialogCancel
   3093 
   3094  event_dialog_open:
   3095    type: event
   3096    description: >
   3097      This is recorded with every user interaction on Activity Stream
   3098      elements.
   3099      This event was generated to correspond to the Legacy Telemetry event
   3100      activity_stream.event#DIALOG_OPEN.
   3101    bugs: *activity_stream_event_bugs
   3102    data_reviews: *activity_stream_event_data_reviews
   3103    notification_emails: *activity_stream_event_emails
   3104    expires: never
   3105    extra_keys: *activity_stream_event_extra
   3106    telemetry_mirror: Activity_stream_Event_DialogOpen
   3107 
   3108  event_drag:
   3109    type: event
   3110    description: >
   3111      This is recorded with every user interaction on Activity Stream
   3112      elements.
   3113      This event was generated to correspond to the Legacy Telemetry event
   3114      activity_stream.event#DRAG.
   3115    bugs: *activity_stream_event_bugs
   3116    data_reviews: *activity_stream_event_data_reviews
   3117    notification_emails: *activity_stream_event_emails
   3118    expires: never
   3119    extra_keys: *activity_stream_event_extra
   3120    telemetry_mirror: Activity_stream_Event_Drag
   3121 
   3122  event_drop:
   3123    type: event
   3124    description: >
   3125      This is recorded with every user interaction on Activity Stream
   3126      elements.
   3127      This event was generated to correspond to the Legacy Telemetry event
   3128      activity_stream.event#DROP.
   3129    bugs: *activity_stream_event_bugs
   3130    data_reviews: *activity_stream_event_data_reviews
   3131    notification_emails: *activity_stream_event_emails
   3132    expires: never
   3133    extra_keys: *activity_stream_event_extra
   3134    telemetry_mirror: Activity_stream_Event_Drop
   3135 
   3136  event_impression:
   3137    type: event
   3138    description: >
   3139      This is recorded with every user interaction on Activity Stream
   3140      elements.
   3141      This event was generated to correspond to the Legacy Telemetry event
   3142      activity_stream.event#IMPRESSION.
   3143    bugs: *activity_stream_event_bugs
   3144    data_reviews: *activity_stream_event_data_reviews
   3145    notification_emails: *activity_stream_event_emails
   3146    expires: never
   3147    extra_keys: *activity_stream_event_extra
   3148    telemetry_mirror: Activity_stream_Event_Impression
   3149 
   3150  event_migration_cancel:
   3151    type: event
   3152    description: >
   3153      This is recorded with every user interaction on Activity Stream
   3154      elements.
   3155      This event was generated to correspond to the Legacy Telemetry event
   3156      activity_stream.event#MIGRATION_CANCEL.
   3157    bugs: *activity_stream_event_bugs
   3158    data_reviews: *activity_stream_event_data_reviews
   3159    notification_emails: *activity_stream_event_emails
   3160    expires: never
   3161    extra_keys: *activity_stream_event_extra
   3162    telemetry_mirror: Activity_stream_Event_MigrationCancel
   3163 
   3164  event_migration_start:
   3165    type: event
   3166    description: >
   3167      This is recorded with every user interaction on Activity Stream
   3168      elements.
   3169      This event was generated to correspond to the Legacy Telemetry event
   3170      activity_stream.event#MIGRATION_START.
   3171    bugs: *activity_stream_event_bugs
   3172    data_reviews: *activity_stream_event_data_reviews
   3173    notification_emails: *activity_stream_event_emails
   3174    expires: never
   3175    extra_keys: *activity_stream_event_extra
   3176    telemetry_mirror: Activity_stream_Event_MigrationStart
   3177 
   3178  event_open_newtab_prefs:
   3179    type: event
   3180    description: >
   3181      This is recorded with every user interaction on Activity Stream
   3182      elements.
   3183      This event was generated to correspond to the Legacy Telemetry event
   3184      activity_stream.event#OPEN_NEWTAB_PREFS.
   3185    bugs: *activity_stream_event_bugs
   3186    data_reviews: *activity_stream_event_data_reviews
   3187    notification_emails: *activity_stream_event_emails
   3188    expires: never
   3189    extra_keys: *activity_stream_event_extra
   3190    telemetry_mirror: Activity_stream_Event_OpenNewtabPrefs
   3191 
   3192  event_open_new_window:
   3193    type: event
   3194    description: >
   3195      This is recorded with every user interaction on Activity Stream
   3196      elements.
   3197      This event was generated to correspond to the Legacy Telemetry event
   3198      activity_stream.event#OPEN_NEW_WINDOW.
   3199    bugs: *activity_stream_event_bugs
   3200    data_reviews: *activity_stream_event_data_reviews
   3201    notification_emails: *activity_stream_event_emails
   3202    expires: never
   3203    extra_keys: *activity_stream_event_extra
   3204    telemetry_mirror: Activity_stream_Event_OpenNewWindow
   3205 
   3206  event_open_private_window:
   3207    type: event
   3208    description: >
   3209      This is recorded with every user interaction on Activity Stream
   3210      elements.
   3211      This event was generated to correspond to the Legacy Telemetry event
   3212      activity_stream.event#OPEN_PRIVATE_WINDOW.
   3213    bugs: *activity_stream_event_bugs
   3214    data_reviews: *activity_stream_event_data_reviews
   3215    notification_emails: *activity_stream_event_emails
   3216    expires: never
   3217    extra_keys: *activity_stream_event_extra
   3218    telemetry_mirror: Activity_stream_Event_OpenPrivateWindow
   3219 
   3220  event_pin:
   3221    type: event
   3222    description: >
   3223      This is recorded with every user interaction on Activity Stream
   3224      elements.
   3225      This event was generated to correspond to the Legacy Telemetry event
   3226      activity_stream.event#PIN.
   3227    bugs: *activity_stream_event_bugs
   3228    data_reviews: *activity_stream_event_data_reviews
   3229    notification_emails: *activity_stream_event_emails
   3230    expires: never
   3231    extra_keys: *activity_stream_event_extra
   3232    telemetry_mirror: Activity_stream_Event_Pin
   3233 
   3234  event_pocket_thumbs_down:
   3235    type: event
   3236    description: >
   3237      This is recorded with every user interaction on Activity Stream
   3238      elements.
   3239      This event was generated to correspond to the Legacy Telemetry event
   3240      activity_stream.event#POCKET_THUMBS_DOWN.
   3241    bugs: *activity_stream_event_bugs
   3242    data_reviews: *activity_stream_event_data_reviews
   3243    notification_emails: *activity_stream_event_emails
   3244    expires: never
   3245    extra_keys: *activity_stream_event_extra
   3246    telemetry_mirror: Activity_stream_Event_PocketThumbsDown
   3247 
   3248  event_pocket_thumbs_up:
   3249    type: event
   3250    description: >
   3251      This is recorded with every user interaction on Activity Stream
   3252      elements.
   3253      This event was generated to correspond to the Legacy Telemetry event
   3254      activity_stream.event#POCKET_THUMBS_UP.
   3255    bugs: *activity_stream_event_bugs
   3256    data_reviews: *activity_stream_event_data_reviews
   3257    notification_emails: *activity_stream_event_emails
   3258    expires: never
   3259    extra_keys: *activity_stream_event_extra
   3260    telemetry_mirror: Activity_stream_Event_PocketThumbsUp
   3261 
   3262  event_pref_changed:
   3263    type: event
   3264    description: >
   3265      This is recorded with every user interaction on Activity Stream
   3266      elements.
   3267      This event was generated to correspond to the Legacy Telemetry event
   3268      activity_stream.event#PREF_CHANGED.
   3269    bugs: *activity_stream_event_bugs
   3270    data_reviews: *activity_stream_event_data_reviews
   3271    notification_emails: *activity_stream_event_emails
   3272    expires: never
   3273    extra_keys: *activity_stream_event_extra
   3274    telemetry_mirror: Activity_stream_Event_PrefChanged
   3275 
   3276  event_preview_request:
   3277    type: event
   3278    description: >
   3279      This is recorded with every user interaction on Activity Stream
   3280      elements.
   3281      This event was generated to correspond to the Legacy Telemetry event
   3282      activity_stream.event#PREVIEW_REQUEST.
   3283    bugs: *activity_stream_event_bugs
   3284    data_reviews: *activity_stream_event_data_reviews
   3285    notification_emails: *activity_stream_event_emails
   3286    expires: never
   3287    extra_keys: *activity_stream_event_extra
   3288    telemetry_mirror: Activity_stream_Event_PreviewRequest
   3289 
   3290  event_search:
   3291    type: event
   3292    description: >
   3293      This is recorded with every user interaction on Activity Stream
   3294      elements.
   3295      This event was generated to correspond to the Legacy Telemetry event
   3296      activity_stream.event#SEARCH.
   3297    bugs: *activity_stream_event_bugs
   3298    data_reviews: *activity_stream_event_data_reviews
   3299    notification_emails: *activity_stream_event_emails
   3300    expires: never
   3301    extra_keys: *activity_stream_event_extra
   3302    telemetry_mirror: Activity_stream_Event_Search
   3303 
   3304  event_search_edit_add:
   3305    type: event
   3306    description: >
   3307      This is recorded with every user interaction on Activity Stream
   3308      elements.
   3309      This event was generated to correspond to the Legacy Telemetry event
   3310      activity_stream.event#SEARCH_EDIT_ADD.
   3311    bugs: *activity_stream_event_bugs
   3312    data_reviews: *activity_stream_event_data_reviews
   3313    notification_emails: *activity_stream_event_emails
   3314    expires: never
   3315    extra_keys: *activity_stream_event_extra
   3316    telemetry_mirror: Activity_stream_Event_SearchEditAdd
   3317 
   3318  event_search_edit_close:
   3319    type: event
   3320    description: >
   3321      This is recorded with every user interaction on Activity Stream
   3322      elements.
   3323      This event was generated to correspond to the Legacy Telemetry event
   3324      activity_stream.event#SEARCH_EDIT_CLOSE.
   3325    bugs: *activity_stream_event_bugs
   3326    data_reviews: *activity_stream_event_data_reviews
   3327    notification_emails: *activity_stream_event_emails
   3328    expires: never
   3329    extra_keys: *activity_stream_event_extra
   3330    telemetry_mirror: Activity_stream_Event_SearchEditClose
   3331 
   3332  event_search_edit_delete:
   3333    type: event
   3334    description: >
   3335      This is recorded with every user interaction on Activity Stream
   3336      elements.
   3337      This event was generated to correspond to the Legacy Telemetry event
   3338      activity_stream.event#SEARCH_EDIT_DELETE.
   3339    bugs: *activity_stream_event_bugs
   3340    data_reviews: *activity_stream_event_data_reviews
   3341    notification_emails: *activity_stream_event_emails
   3342    expires: never
   3343    extra_keys: *activity_stream_event_extra
   3344    telemetry_mirror: Activity_stream_Event_SearchEditDelete
   3345 
   3346  event_search_handoff:
   3347    type: event
   3348    description: >
   3349      This is recorded with every user interaction on Activity Stream
   3350      elements.
   3351      This event was generated to correspond to the Legacy Telemetry event
   3352      activity_stream.event#SEARCH_HANDOFF.
   3353    bugs: *activity_stream_event_bugs
   3354    data_reviews: *activity_stream_event_data_reviews
   3355    notification_emails: *activity_stream_event_emails
   3356    expires: never
   3357    extra_keys: *activity_stream_event_extra
   3358    telemetry_mirror: Activity_stream_Event_SearchHandoff
   3359 
   3360  event_show_privacy_info:
   3361    type: event
   3362    description: >
   3363      This is recorded with every user interaction on Activity Stream
   3364      elements.
   3365      This event was generated to correspond to the Legacy Telemetry event
   3366      activity_stream.event#SHOW_PRIVACY_INFO.
   3367    bugs: *activity_stream_event_bugs
   3368    data_reviews: *activity_stream_event_data_reviews
   3369    notification_emails: *activity_stream_event_emails
   3370    expires: never
   3371    extra_keys: *activity_stream_event_extra
   3372    telemetry_mirror: Activity_stream_Event_ShowPrivacyInfo
   3373 
   3374  event_skipped_signin:
   3375    type: event
   3376    description: >
   3377      This is recorded with every user interaction on Activity Stream
   3378      elements.
   3379      This event was generated to correspond to the Legacy Telemetry event
   3380      activity_stream.event#SKIPPED_SIGNIN.
   3381    bugs: *activity_stream_event_bugs
   3382    data_reviews: *activity_stream_event_data_reviews
   3383    notification_emails: *activity_stream_event_emails
   3384    expires: never
   3385    extra_keys: *activity_stream_event_extra
   3386    telemetry_mirror: Activity_stream_Event_SkippedSignin
   3387 
   3388  event_submit_email:
   3389    type: event
   3390    description: >
   3391      This is recorded with every user interaction on Activity Stream
   3392      elements.
   3393      This event was generated to correspond to the Legacy Telemetry event
   3394      activity_stream.event#SUBMIT_EMAIL.
   3395    bugs: *activity_stream_event_bugs
   3396    data_reviews: *activity_stream_event_data_reviews
   3397    notification_emails: *activity_stream_event_emails
   3398    expires: never
   3399    extra_keys: *activity_stream_event_extra
   3400    telemetry_mirror: Activity_stream_Event_SubmitEmail
   3401 
   3402  event_disclaimer_acked:
   3403    type: event
   3404    description: >
   3405      This is recorded with every user interaction on Activity Stream
   3406      elements.
   3407      This event was generated to correspond to the Legacy Telemetry event
   3408      activity_stream.event#DISCLAIMER_ACKED.
   3409    bugs: *activity_stream_event_bugs
   3410    data_reviews: *activity_stream_event_data_reviews
   3411    notification_emails: *activity_stream_event_emails
   3412    expires: never
   3413    extra_keys: *activity_stream_event_extra
   3414    telemetry_mirror: Activity_stream_Event_DisclaimerAcked
   3415 
   3416  event_menu_add_search:
   3417    type: event
   3418    description: >
   3419      This is recorded with every user interaction on Activity Stream
   3420      elements.
   3421      This event was generated to correspond to the Legacy Telemetry event
   3422      activity_stream.event#MENU_ADD_SEARCH.
   3423    bugs: *activity_stream_event_bugs
   3424    data_reviews: *activity_stream_event_data_reviews
   3425    notification_emails: *activity_stream_event_emails
   3426    expires: never
   3427    extra_keys: *activity_stream_event_extra
   3428    telemetry_mirror: Activity_stream_Event_MenuAddSearch
   3429 
   3430  event_menu_add_topsite:
   3431    type: event
   3432    description: >
   3433      This is recorded with every user interaction on Activity Stream
   3434      elements.
   3435      This event was generated to correspond to the Legacy Telemetry event
   3436      activity_stream.event#MENU_ADD_TOPSITE.
   3437    bugs: *activity_stream_event_bugs
   3438    data_reviews: *activity_stream_event_data_reviews
   3439    notification_emails: *activity_stream_event_emails
   3440    expires: never
   3441    extra_keys: *activity_stream_event_extra
   3442    telemetry_mirror: Activity_stream_Event_MenuAddTopsite
   3443 
   3444  event_menu_collapse:
   3445    type: event
   3446    description: >
   3447      This is recorded with every user interaction on Activity Stream
   3448      elements.
   3449      This event was generated to correspond to the Legacy Telemetry event
   3450      activity_stream.event#MENU_COLLAPSE.
   3451    bugs: *activity_stream_event_bugs
   3452    data_reviews: *activity_stream_event_data_reviews
   3453    notification_emails: *activity_stream_event_emails
   3454    expires: never
   3455    extra_keys: *activity_stream_event_extra
   3456    telemetry_mirror: Activity_stream_Event_MenuCollapse
   3457 
   3458  event_menu_expand:
   3459    type: event
   3460    description: >
   3461      This is recorded with every user interaction on Activity Stream
   3462      elements.
   3463      This event was generated to correspond to the Legacy Telemetry event
   3464      activity_stream.event#MENU_EXPAND.
   3465    bugs: *activity_stream_event_bugs
   3466    data_reviews: *activity_stream_event_data_reviews
   3467    notification_emails: *activity_stream_event_emails
   3468    expires: never
   3469    extra_keys: *activity_stream_event_extra
   3470    telemetry_mirror: Activity_stream_Event_MenuExpand
   3471 
   3472  event_menu_manage:
   3473    type: event
   3474    description: >
   3475      This is recorded with every user interaction on Activity Stream
   3476      elements.
   3477      This event was generated to correspond to the Legacy Telemetry event
   3478      activity_stream.event#MENU_MANAGE.
   3479    bugs: *activity_stream_event_bugs
   3480    data_reviews: *activity_stream_event_data_reviews
   3481    notification_emails: *activity_stream_event_emails
   3482    expires: never
   3483    extra_keys: *activity_stream_event_extra
   3484    telemetry_mirror: Activity_stream_Event_MenuManage
   3485 
   3486  event_menu_move_down:
   3487    type: event
   3488    description: >
   3489      This is recorded with every user interaction on Activity Stream
   3490      elements.
   3491      This event was generated to correspond to the Legacy Telemetry event
   3492      activity_stream.event#MENU_MOVE_DOWN.
   3493    bugs: *activity_stream_event_bugs
   3494    data_reviews: *activity_stream_event_data_reviews
   3495    notification_emails: *activity_stream_event_emails
   3496    expires: never
   3497    extra_keys: *activity_stream_event_extra
   3498    telemetry_mirror: Activity_stream_Event_MenuMoveDown
   3499 
   3500  event_menu_move_up:
   3501    type: event
   3502    description: >
   3503      This is recorded with every user interaction on Activity Stream
   3504      elements.
   3505      This event was generated to correspond to the Legacy Telemetry event
   3506      activity_stream.event#MENU_MOVE_UP.
   3507    bugs: *activity_stream_event_bugs
   3508    data_reviews: *activity_stream_event_data_reviews
   3509    notification_emails: *activity_stream_event_emails
   3510    expires: never
   3511    extra_keys: *activity_stream_event_extra
   3512    telemetry_mirror: Activity_stream_Event_MenuMoveUp
   3513 
   3514  event_menu_privacy_notice:
   3515    type: event
   3516    description: >
   3517      This is recorded with every user interaction on Activity Stream
   3518      elements.
   3519      This event was generated to correspond to the Legacy Telemetry event
   3520      activity_stream.event#MENU_PRIVACY_NOTICE.
   3521    bugs: *activity_stream_event_bugs
   3522    data_reviews: *activity_stream_event_data_reviews
   3523    notification_emails: *activity_stream_event_emails
   3524    expires: never
   3525    extra_keys: *activity_stream_event_extra
   3526    telemetry_mirror: Activity_stream_Event_MenuPrivacyNotice
   3527 
   3528  event_menu_remove:
   3529    type: event
   3530    description: >
   3531      This is recorded with every user interaction on Activity Stream
   3532      elements.
   3533      This event was generated to correspond to the Legacy Telemetry event
   3534      activity_stream.event#MENU_REMOVE.
   3535    bugs: *activity_stream_event_bugs
   3536    data_reviews: *activity_stream_event_data_reviews
   3537    notification_emails: *activity_stream_event_emails
   3538    expires: never
   3539    extra_keys: *activity_stream_event_extra
   3540    telemetry_mirror: Activity_stream_Event_MenuRemove
   3541 
   3542  event_top_sites_edit:
   3543    type: event
   3544    description: >
   3545      This is recorded with every user interaction on Activity Stream
   3546      elements.
   3547      This event was generated to correspond to the Legacy Telemetry event
   3548      activity_stream.event#TOP_SITES_EDIT.
   3549    bugs: *activity_stream_event_bugs
   3550    data_reviews: *activity_stream_event_data_reviews
   3551    notification_emails: *activity_stream_event_emails
   3552    expires: never
   3553    extra_keys: *activity_stream_event_extra
   3554    telemetry_mirror: Activity_stream_Event_TopSitesEdit
   3555 
   3556  event_top_sites_edit_close:
   3557    type: event
   3558    description: >
   3559      This is recorded with every user interaction on Activity Stream
   3560      elements.
   3561      This event was generated to correspond to the Legacy Telemetry event
   3562      activity_stream.event#TOP_SITES_EDIT_CLOSE.
   3563    bugs: *activity_stream_event_bugs
   3564    data_reviews: *activity_stream_event_data_reviews
   3565    notification_emails: *activity_stream_event_emails
   3566    expires: never
   3567    extra_keys: *activity_stream_event_extra
   3568    telemetry_mirror: Activity_stream_Event_TopSitesEditClose
   3569 
   3570  event_topsite_sponsor_info:
   3571    type: event
   3572    description: >
   3573      This is recorded with every user interaction on Activity Stream
   3574      elements.
   3575      This event was generated to correspond to the Legacy Telemetry event
   3576      activity_stream.event#TOPSITE_SPONSOR_INFO.
   3577    bugs: *activity_stream_event_bugs
   3578    data_reviews: *activity_stream_event_data_reviews
   3579    notification_emails: *activity_stream_event_emails
   3580    expires: never
   3581    extra_keys: *activity_stream_event_extra
   3582    telemetry_mirror: Activity_stream_Event_TopsiteSponsorInfo
   3583 
   3584  event_unpin:
   3585    type: event
   3586    description: >
   3587      This is recorded with every user interaction on Activity Stream
   3588      elements.
   3589      This event was generated to correspond to the Legacy Telemetry event
   3590      activity_stream.event#UNPIN.
   3591    bugs: *activity_stream_event_bugs
   3592    data_reviews: *activity_stream_event_data_reviews
   3593    notification_emails: *activity_stream_event_emails
   3594    expires: never
   3595    extra_keys: *activity_stream_event_extra
   3596    telemetry_mirror: Activity_stream_Event_Unpin
   3597 
   3598 deletion.request:
   3599  impression_id:
   3600    type: string
   3601    description: >
   3602      An identifier used by user interaction pings in Pocket/newtab and
   3603      Messaging System.
   3604      This metric was generated to correspond to the Legacy Telemetry
   3605      scalar deletion.request.impression_id.
   3606    bugs:
   3607      - https://bugzil.la/1602064
   3608    data_reviews:
   3609      - https://bugzil.la/1602064
   3610    notification_emails:
   3611      - najiang@mozilla.com
   3612    expires: never
   3613    send_in_pings: ["deletion-request"]
   3614    telemetry_mirror: DELETION_REQUEST_IMPRESSION_ID
   3615 
   3616  context_id:
   3617    type: string
   3618    description: >
   3619      An identifier to identify users for Contextual Services user
   3620      interaction pings.
   3621      This metric was generated to correspond to the Legacy Telemetry
   3622      scalar deletion.request.context_id.
   3623    bugs:
   3624      - https://bugzil.la/1729474
   3625    data_reviews:
   3626      - https://bugzil.la/1729474
   3627    notification_emails:
   3628      - najiang@mozilla.com
   3629    expires: never
   3630    send_in_pings: ["deletion-request"]
   3631    telemetry_mirror: DELETION_REQUEST_CONTEXT_ID
   3632 
   3633 contextual.services.topsites:
   3634  impression:
   3635    type: labeled_counter
   3636    description: >
   3637      A keyed uint recording how many times the user has viewed the
   3638      sponsored TopSites on the newtab page. The key is a combination of
   3639      the source and the placement of the TopSites tile (1-based). such as
   3640      'urlbar_1', 'newtab_2'.
   3641      This metric was generated to correspond to the Legacy Telemetry
   3642      scalar contextual.services.topsites.impression.
   3643    bugs:
   3644      - https://bugzil.la/1688698
   3645    data_reviews:
   3646      - https://bugzil.la/1688698
   3647    notification_emails:
   3648      - najiang@mozilla.com
   3649    expires: never
   3650    telemetry_mirror: CONTEXTUAL_SERVICES_TOPSITES_IMPRESSION
   3651 
   3652  click:
   3653    type: labeled_counter
   3654    description: >
   3655      A keyed uint recording how many times the user has clicked on the
   3656      sponsored TopSites on the newtab page. The key is a combination of
   3657      the source and the placement of the TopSites tile (1-based). such as
   3658      'urlbar_1', 'newtab_2'.
   3659      This metric was generated to correspond to the Legacy Telemetry
   3660      scalar contextual.services.topsites.click.
   3661    bugs:
   3662      - https://bugzil.la/1688698
   3663    data_reviews:
   3664      - https://bugzil.la/1688698
   3665    notification_emails:
   3666      - najiang@mozilla.com
   3667    expires: never
   3668    telemetry_mirror: CONTEXTUAL_SERVICES_TOPSITES_CLICK