browser/components/search/metrics.yaml

   1 # This Source Code Form is subject to the terms of the Mozilla Public
   2 # License, v. 2.0. If a copy of the MPL was not distributed with this
   3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   4
   5 # Adding a new metric? We have docs for that!
   6 # https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
   7
   8 ---
   9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
  10 $tags:
  11   - 'Firefox :: Search'
  12
  13 newtab.search:
  14   issued:
  15     type: event
  16     description: >
  17       When Firefox was asked to issue a search from a Search Access Point (SAP)
  18       on a newtab page.
  19       Doesn't record searches in Private Browsing Mode unless
  20       `browser.engagement.search_counts.pbm` is set to `true`.
  21     bugs:
  22       - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
  23       - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
  24       - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
  25     data_reviews:
  26       - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
  27       - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
  28       - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
  29     data_sensitivity:
  30       - interaction
  31     notification_emails:
  32       - anicholson@mozilla.com
  33       - chutten@mozilla.com
  34       - mmccorquodale@mozilla.com
  35       - najiang@mozilla.com
  36       - lina@mozilla.com
  37     expires: never
  38     extra_keys:
  39       newtab_visit_id: &newtab_visit_id
  40         description: >
  41           The id of the newtab visit that originated the search.
  42           Should always be present for handoff searches.
  43           TODO(bug 1774597): for searches done without handoff (e.g. with
  44           `browser.newtabpage.activity-stream.improvesearch.handoffToAwesomebar`
  45           set to `false`), the active newtab visit id is unknown.
  46         type: string
  47       search_access_point: &search_access_point
  48         description: >
  49           One of the search access points available on the new tab like
  50           * `urlbar_handoff`
  51           * `about_home`
  52           * `about_newtab`
  53         type: string
  54       telemetry_id: &telemetry_id
  55         description: >
  56           The search engine's `telemetryId`, like `google-b-d`.
  57           This is set to be a telemetry-specific id for app-provided engines,
  58           and is `other-<name>` for others (where `<name>` is the engine's
  59           WebExtension name).
  60         type: string
  61     send_in_pings:
  62       - newtab
  63
  64 newtab.search.ad:
  65   impression:
  66     type: event
  67     description: >
  68       Recorded when a newtab visit resulted in a search that
  69       loaded a Search Engine Result Page (SERP) that contains an ad link.
  70       And the SERP is visible.
  71     bugs:
  72       - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
  73       - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
  74       - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
  75     data_reviews:
  76       - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
  77       - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
  78       - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
  79     data_sensitivity:
  80       - interaction
  81     notification_emails:
  82       - anicholson@mozilla.com
  83       - chutten@mozilla.com
  84       - mmccorquodale@mozilla.com
  85       - najiang@mozilla.com
  86       - lina@mozilla.com
  87     expires: never
  88     extra_keys:
  89       newtab_visit_id: *newtab_visit_id
  90       search_access_point: *search_access_point
  91       is_follow_on: &is_follow_on
  92         description: >
  93           Whether the preceding search happened on a search results page.
  94         type: boolean
  95       is_tagged: &is_tagged
  96         description: >
  97           Whether the preceding search was tagged with a partner code.
  98         type: boolean
  99       telemetry_id: *telemetry_id
 100     send_in_pings:
 101       - newtab
 102
 103   click:
 104     type: event
 105     description: >
 106       Recorded when an ad link is clicked on a Search Engine Result Page (SERP)
 107       which was loaded by a seach that began on a newtab page.
 108     bugs:
 109       - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
 110       - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670
 111       - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105
 112     data_reviews:
 113       - https://bugzilla.mozilla.org/show_bug.cgi?id=1766887
 114       - https://bugzilla.mozilla.org/show_bug.cgi?id=1786670#c3
 115       - https://bugzilla.mozilla.org/show_bug.cgi?id=1817105#c11
 116     data_sensitivity:
 117       - interaction
 118     notification_emails:
 119       - anicholson@mozilla.com
 120       - chutten@mozilla.com
 121       - mmccorquodale@mozilla.com
 122       - najiang@mozilla.com
 123       - lina@mozilla.com
 124     expires: never
 125     extra_keys:
 126       newtab_visit_id: *newtab_visit_id
 127       search_access_point: *search_access_point
 128       is_follow_on: *is_follow_on
 129       is_tagged: *is_tagged
 130       telemetry_id: *telemetry_id
 131     send_in_pings:
 132       - newtab
 133
 134 serp:
 135   impression:
 136     type: event
 137     description: >
 138       Recorded when a search engine results page (SERP) is shown to a user.
 139     bugs:
 140       - https://bugzilla.mozilla.org/show_bug.cgi?id=1813162
 141       - https://bugzilla.mozilla.org/show_bug.cgi?id=1824543
 142       - https://bugzilla.mozilla.org/show_bug.cgi?id=1816736
 143       - https://bugzilla.mozilla.org/show_bug.cgi?id=1816738
 144       - https://bugzilla.mozilla.org/show_bug.cgi?id=1829953
 145     data_reviews:
 146       - https://bugzilla.mozilla.org/show_bug.cgi?id=1813162
 147       - https://bugzilla.mozilla.org/show_bug.cgi?id=1824543
 148     data_sensitivity:
 149       - interaction
 150     notification_emails:
 151       - fx-search-telemetry@mozilla.com
 152       - rev-data@mozilla.com
 153     expires: never
 154     extra_keys:
 155       impression_id: &impression_id
 156         description: >
 157           A uuid to link SERP events to user's engagement events.
 158         type: string
 159       provider:
 160         description: >
 161           The name of the provider.
 162         type: string
 163       tagged:
 164         description: >
 165           Whether the search is tagged (true) or organic (false).
 166         type: boolean
 167       partner_code:
 168         description: >
 169           Any partner_code parsing in the URL or an empty string if not
 170           available.
 171         type: string
 172       source:
 173         description: >
 174           How the user arrived at the SERP.
 175           Possible values are:
 176           `urlbar`, `urlbar_handoff`, `urlbar_searchmode`, `urlbar_persisted`,
 177           `searchbar`, `contextmenu`, `webextension`, `system`, `reload`,
 178           `tabhistory`, `follow_on_from_refine_on_incontent_search`,
 179           `follow_on_from_refine_on_SERP`, `opened_in_new_tab`, `unknown`.
 180           This will be `unknown` if we cannot determine the source.
 181         type: string
 182       shopping_tab_displayed:
 183         description:
 184           Indicates if the shopping tab is displayed.
 185         type: boolean
 186       is_shopping_page:
 187         description:
 188           Indicates if the page is a shopping page.
 189         type: boolean
 190
 191   engagement:
 192     type: event
 193     description: >
 194       Recorded user actions on a SERP.
 195     bugs:
 196       - https://bugzilla.mozilla.org/show_bug.cgi?id=1814773
 197       - https://bugzilla.mozilla.org/show_bug.cgi?id=1816730
 198       - https://bugzilla.mozilla.org/show_bug.cgi?id=1816735
 199     data_reviews:
 200       - https://bugzilla.mozilla.org/show_bug.cgi?id=1814773
 201       - https://bugzilla.mozilla.org/show_bug.cgi?id=1816730
 202     data_sensitivity:
 203       - interaction
 204     notification_emails:
 205       - fx-search-telemetry@mozilla.com
 206       - rev-data@mozilla.com
 207     expires: never
 208     extra_keys:
 209       impression_id: *impression_id
 210       action:
 211         description: >
 212           The action taken on the page.
 213           Possible values are `clicked`, `expanded`, and `submitted`.
 214         type: string
 215       target:
 216         description: >
 217           The target component used to trigger the action.
 218           Possible values are:
 219           `ad_carousel`,
 220           `ad_image_row`,
 221           `ad_link`,
 222           `ad_sidebar`,
 223           `ad_sitelink`,
 224           `incontent_searchbox`,
 225           `refined_search_buttons`,
 226           `shopping_tab`.
 227         type: string
 228
 229   ad_impression:
 230     type: event
 231     description: >
 232       Recorded when a user loads a SERP and ads are detected.
 233     bugs:
 234       - https://bugzilla.mozilla.org/show_bug.cgi?id=1816728
 235       - https://bugzilla.mozilla.org/show_bug.cgi?id=1816729
 236     data_reviews:
 237       - https://bugzilla.mozilla.org/show_bug.cgi?id=1816728
 238     data_sensitivity:
 239       - interaction
 240     notification_emails:
 241       - fx-search-telemetry@mozilla.com
 242       - rev-data@mozilla.com
 243     expires: never
 244     extra_keys:
 245       impression_id: *impression_id
 246       component:
 247         description: >
 248           Type of components on a SERP. Possible values are:
 249           `ad_carousel`,
 250           `ad_image_row`,
 251           `ad_link`,
 252           `ad_sidebar`,
 253           `ad_sitelink`,
 254           `refined_search_buttons`,
 255           `shopping_tab`.
 256           Defaults to `ad_link`.
 257         type: string
 258       ads_loaded:
 259         description: >
 260           Number of ads loaded for this component. They may or
 261           may not be visible on the page.
 262         type: quantity
 263       ads_visible:
 264         description: >
 265           Number of ads visible for this component. An ad can be
 266           considered visible if was within the browser window
 267           by the time the impression was recorded.
 268         type: quantity
 269       ads_hidden:
 270         description: >
 271           Number of ads hidden for this component. These are ads that
 272           are loaded in the DOM but hidden via CSS and/or Javascript.
 273         type: quantity
 274
 275   abandonment:
 276     type: event
 277     description: >
 278       Recorded when there is no engagement with the SERP before the tab is
 279       closed, the window is closed, the app is closed, or the tab is navigated
 280       away from.
 281     bugs:
 282       - https://bugzilla.mozilla.org/show_bug.cgi?id=1814776
 283     data_reviews:
 284       - https://bugzilla.mozilla.org/show_bug.cgi?id=1814776
 285     data_sensitivity:
 286       - interaction
 287     notification_emails:
 288       - fx-search-telemetry@mozilla.com
 289       - rev-data@mozilla.com
 290     expires: never
 291     extra_keys:
 292       impression_id: *impression_id
 293       reason:
 294         description: >
 295           Why the SERP is deemed abandoned.
 296           Possible values are:
 297           `tab_close`, `window_close`, `navigation`
 298         type: string
 299
 300   categorization_duration:
 301     type: timing_distribution
 302     time_unit: millisecond
 303     description: >
 304       The time it takes to categorize elements on a SERP.
 305     bugs:
 306       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834100
 307     data_reviews:
 308       - https://bugzilla.mozilla.org/show_bug.cgi?id=1834100
 309     data_sensitivity:
 310       - technical
 311     notification_emails:
 312       - fx-search-telemetry@mozilla.com
 313     expires: never