Source code
Revision control
Copy as Markdown
Other Tools
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# Adding a new metric? We have docs for that!
---
$tags:
- "Firefox :: Address Bar"
urlbar:
abandonment:
type: event
description: Recorded when the user abandons a search (blurring the urlbar).
extra_keys:
abandonment_type:
description: >
Records the reason that resulted in an abandonment. The possible
values are: `blur` and `tab_switch`.
type: string
sap:
description: >
`sap` is the meaning of `search access point`. It records where the
user started the search action from. The possible values are: `urlbar`
, `handoff`, `urlbar_newtab` and `urlbar_addonpage`.
type: string
interaction:
description: >
How the user started the search action. The possible values are:
`typed`, `pasted`, `topsite_search` (clicked on a topsite search
shortcut), `topsites` (selected a topsite result with empty search
string), `returned` (The user abandoned a search, then returned to it)
, `restarted` (The user abandoned a search, then returned to it,
cleared it and typed a completely different string), `refined` (The
user abandoned a search, then returned to it, and partially modified
the string), `persisted_search_terms` (The user returned to a previous
successful search that persisted terms in the urlbar),
`persisted_search_terms_restarted` (The user returned to a previous
successful search that persisted terms in the urlbar, then cleared it
and typed a completely different string) and
`persisted_search_terms_refined` (The user returned to a previous
successful search that persisted terms in the urlbar, and partially
modified the string).
type: string
search_mode:
description: >
If the urlbar is in search mode, thus restricting results to a
specific search engine or local source, this is set to the search mode
source. The possible sources are: `actions`, `bookmarks`, `history`,
`search_engine`, and `tabs`. If search mode is active but the source
did not fall into any of these categories, this will be `unknown`. If
search mode is not active, this will be an empty string.
type: string
search_engine_default_id:
description: >
The telemetry id of the search engine.
Reflects `search.engine.default.engine_id`.
type: string
n_chars:
description: >
The length of string used for the search. It includes whitespaces.
type: quantity
n_words:
description: >
The length of words used for the search. The words are made by
splitting the search string by whitespaces, thus this doesn’t support
CJK languages. For performance reasons a maximum of 255 characters are
considered when splitting.
type: quantity
n_results:
description: >
The number of results shown to the user. If this is high the results
list below may be truncated due to technical limitations. Also note in
that case not all the results may be physically visible due to the
screen size limitation.
type: quantity
groups:
description: >
Comma separated list of result groups in the order they were shown to
the user. The groups may be repeated, since the list will match 1:1
the results list, so we can link each result to a group. The possible
group names are: `heuristic`, `adaptive_history`, `search_history`,
`search_suggest`, `search_suggest_rich`, `trending_search`,
`trending_search_rich`, `top_pick`, `top_site`, `remote_tab`,
`addon`, `general`, `suggest`, `about_page` and `suggested_index`. If
the group did not fall into any of these, this will be `unknown` and
a bug should be filed to investigate it.
type: string
results:
description: >
Comma separated list of result types in the order they were shown to
the user. The `unknown` type should not occur and indicates a bug. The
possible types are:
`action`,
`addon`,
`autofill_about`,
`autofill_adaptive`,
`autofill_origin`,
`autofill_unknown`,
`autofill_url`,
`bookmark`,
`calc`,
`clipboard`,
`fxsuggest_data_sharing_opt_in`,
`history`,
`intervention_clear`,
`intervention_refresh`,
`intervention_unknown`,
`intervention_update`,
`keyword`,
`merino_adm_sponsored`,
`merino_amo`,
`merino_top_picks`,
`merino_wikipedia`,
`recent_search`,
`remote_tab`,
`rs_adm_nonsponsored`,
`rs_adm_sponsored`,
`rs_amo`,
`rs_mdn`,
`rs_pocket`,
`rust_adm_nonsponsored`,
`rust_adm_sponsored`,
`rust_amo`,
`rust_mdn`,
`rust_pocket`,
`rust_yelp`,
`search_engine`,
`search_history`,
`search_suggest`,
`search_suggest_rich`,
`tab`,
`tab_to_search`,
`tip_dismissal_acknowledgment`,
`tip_onboard`,
`tip_persist`,
`tip_redirect`,
`tip_unknown`,
`top_site`,
`trending_search`,
`trending_search_rich`,
`unit`,
`url`,
`weather`
type: string
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
engagement:
type: event
description: Recorded when the user executes an action on a result.
extra_keys:
sap:
description: >
`sap` is the meaning of `search access point`. It records where the
user started the search action from. The possible values are: `urlbar`
, `handoff`, `urlbar_newtab` and `urlbar_addonpage`.
type: string
interaction:
description: >
How the user started the search action. The possible values are:
`typed`, `pasted`, `topsite_search` (clicked on a topsite search
shortcut), `topsites` (selected a topsite result with empty search
string), `returned` (The user abandoned a search, then returned to it)
, `restarted` (The user abandoned a search, then returned to it,
cleared it and typed a completely different string), `refined` (The
user abandoned a search, then returned to it, and partially modified
the string), `persisted_search_terms` (The user returned to a previous
successful search that persisted terms in the urlbar),
`persisted_search_terms_restarted` (The user returned to a previous
successful search that persisted terms in the urlbar, then cleared it
and typed a completely different string) and
`persisted_search_terms_refined` (The user returned to a previous
successful search that persisted terms in the urlbar, and partially
modified the string).
type: string
search_mode:
description: >
If the urlbar is in search mode, thus restricting results to a
specific search engine or local source, this is set to the search mode
source. The possible sources are: `actions`, `bookmarks`, `history`,
`search_engine`, and `tabs`. If search mode is active but the source
did not fall into any of these categories, this will be `unknown`. If
search mode is not active, this will be an empty string.
type: string
search_engine_default_id:
description: >
The telemetry id of the search engine.
Reflects `search.engine.default.engine_id`.
type: string
n_chars:
description: >
The length of string used for the search. It includes whitespaces.
type: quantity
n_words:
description: >
The length of words used for the search. The words are made by
splitting the search string by whitespaces, thus this doesn’t support
CJK languages. For performance reasons a maximum of 255 characters are
considered when splitting.
type: quantity
n_results:
description: >
The number of results shown to the user. If this is high the results
list below may be truncated due to technical limitations. Also note in
that case not all the results may be physically visible due to the
screen size limitation.
type: quantity
selected_result:
description: >
The type of the result the user selected. The `unknown` type should
not occur and indicates a bug. The possible types are:
`action`,
`addon`,
`autofill_about`,
`autofill_adaptive`,
`autofill_origin`,
`autofill_unknown`,
`autofill_url`,
`bookmark`,
`calc`,
`clipboard`,
`experimental_addon`,
`fxsuggest_data_sharing_opt_in`,
`history`,
`input_field`,
`intervention_clear`,
`intervention_refresh`,
`intervention_unknown`,
`intervention_update`,
`keyword`,
`merino_adm_sponsored`,
`merino_amo`,
`merino_top_picks`,
`merino_wikipedia`,
`recent_search`,
`remote_tab`,
`rs_adm_nonsponsored`,
`rs_adm_sponsored`,
`rs_amo`,
`rs_mdn`,
`rs_pocket`,
`rust_adm_nonsponsored`,
`rust_adm_sponsored`,
`rust_amo`,
`rust_mdn`,
`rust_pocket`,
`rust_yelp`,
`search_engine`,
`search_history`,
`search_shortcut_button`,
`search_suggest`,
`search_suggest_rich`,
`site_specific_contextual_search`,
`tab`,
`tab_to_search`,
`tip_dismissal_acknowledgment`,
`tip_onboard`,
`tip_persist`,
`tip_redirect`,
`tip_unknown`,
`top_site`,
`trending_search`,
`trending_search_rich`,
`unit`,
`url`,
`weather`
type: string
selected_result_subtype:
description: >
The subtype of the result the user selected. Currently, only the
action of the quick actions is the target to this. The possible values
are: `addon`, `bookmarks`, `clear`, `downloads`, `extensions`,
`inspect`, `logins`, `plugins`, `print`, `private`, `refresh`,
`restart`, `screenshot`, `settings`, `themes`, `update` and
`viewsource`. Otherwise, an empty string is returned.
type: string
selected_position:
description: >
The 1-based index of the result the user selected. If user searched
without selection, 0 will be recorded.
type: quantity
provider:
description: >
The name of the `UrlbarProvider` that provided the selected result.
The possible values are: `AboutPages`, `AliasEngines`, `Autofill`,
`BookmarkKeywords`, `calculator`, `UrlbarProviderContextualSearch`,
`HeuristicFallback`, `HistoryUrlHeuristic`, `InputHistory`,
`UrlbarProviderInterventions`, `Omnibox`, `OpenTabs`, `Places`,
`PrivateSearch`, `quickactions`, `UrlbarProviderQuickSuggest`,
`RemoteTabs`, `SearchSuggestions`, `UrlbarProviderSearchTips`,
`TabToSearch`, `TokenAliasEngines`, `UrlbarProviderTopSites`,
`UnitConversion` and `UnifiedComplete`.
If engagement_type is `drop_go` or `paste_go`, this will be null
because no results are shown. And also, if selected_result is
`experimental_addon`, it means that the user selected a result
from an add-on using the urlbar experimental API. In this case,
this will be the provider name specified by the add-on.
type: string
engagement_type:
description: >
Records how the user selected the result. The possible values are:
`click`,
`dismiss`,
`drop_go`,
`enter`,
`go_button`,
`help`,
`inaccurate_location`,
`manage`,
`not_interested`,
`not_relevant`,
`paste_go`,
`show_less_frequently`
type: string
groups:
description: >
Comma separated list of result groups in the order they were shown to
the user. The groups may be repeated, since the list will match 1:1
the results list, so we can link each result to a group. The possible
group names are: `heuristic`, `adaptive_history`, `search_history`,
`search_suggest`, `search_suggest_rich`, `trending_search`,
`trending_search_rich`, `top_pick`, `top_site`, `recent_search`,
`remote_tab`, `addon`, `general`, `suggest`, `about_page` and
`suggested_index`. If the group did not fall into any of these, this
will be `unknown` and a bug should be filed to investigate it. If
engagement_type is `drop_go` or `paste_go`, this will be empty string
because no results are shown.
type: string
results:
description: >
Comma separated list of result types in the order they were shown to
the user. The `unknown` type should not occur and indicates a bug. The
possible types are:
`action`,
`addon`,
`autofill_about`,
`autofill_adaptive`,
`autofill_origin`,
`autofill_unknown`,
`autofill_url`,
`bookmark`,
`calc`,
`clipboard`,
`fxsuggest_data_sharing_opt_in`,
`history`,
`intervention_clear`,
`intervention_refresh`,
`intervention_unknown`,
`intervention_update`,
`keyword`,
`merino_adm_sponsored`,
`merino_amo`,
`merino_top_picks`,
`merino_wikipedia`,
`recent_search`,
`remote_tab`,
`rs_adm_nonsponsored`,
`rs_adm_sponsored`,
`rs_amo`,
`rs_mdn`,
`rs_pocket`,
`rust_adm_nonsponsored`,
`rust_adm_sponsored`,
`rust_amo`,
`rust_mdn`,
`rust_pocket`,
`rust_yelp`,
`search_engine`,
`search_history`,
`search_suggest`,
`search_suggest_rich`,
`tab`,
`tab_to_search`,
`tip_dismissal_acknowledgment`,
`tip_onboard`,
`tip_persist`,
`tip_redirect`,
`tip_unknown`,
`top_site`,
`trending_search`,
`trending_search_rich`,
`unit`,
`url`,
`weather`
type: string
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
exposure:
type: event
description: >
Recorded when client is exposed to urlbar experiment results.
extra_keys:
results:
description: >
Comma separated list of results that were visible to the user.
type: string
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
potential_exposure:
type: event
description: >
This event is recorded in the `urlbar-potential-exposure` ping, which is
submitted at the end of urlbar sessions during which the user typed a
keyword defined by the Nimbus variable `potentialExposureKeywords`. A
"session" begins when the user focuses the urlbar and ends with an
engagement or abandonment. The ping will contain one event per unique
keyword that is typed during the session. This ping is not submitted for
sessions in private windows.
extra_keys:
keyword:
type: string
description: >
The matched keyword.
terminal:
type: boolean
description: >
Whether the matched keyword was present at the end of the urlbar
session. If true, the session ended with the keyword. If false, the
keyword was typed at some point during the session but the session
did not end with it.
bugs:
data_reviews:
data_sensitivity:
- stored_content
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
send_in_pings:
- urlbar-potential-exposure
quick_suggest_contextual_opt_in:
type: event
description: >
Recorded when the contextual opt-in UI is shown or interacted with.
extra_keys:
interaction:
description: >
The type of interaction. Possible values: `impression`, `dismiss`,
`allow`, `learn_more`.
type: string
top_position:
description: >
Whether the opt-in result appeared at the very top of results or at
the bottom, after one-off buttons.
type: boolean
say_hello:
description: >
Whether the alternative copy was used for the opt-in result.
type: boolean
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: 132
pref_max_results:
lifetime: application
type: quantity
unit: integer
description: >
Maximum results to show in the Address Bar.
Corresponds to the value of the `browser.urlbar.maxRichResults` pref.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
send_in_pings:
- events
pref_suggest_data_collection:
lifetime: application
type: boolean
description: >
Whether the user has opted in to data collection for Firefox Suggest,
i.e., online suggestions served from Merino.
Corresponds to the value of the
`browser.urlbar.quicksuggest.dataCollection.enabled` pref.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
send_in_pings:
- events
pref_suggest_nonsponsored:
lifetime: application
type: boolean
description: >
Whether non-sponsored quick suggest results are shown in the urlbar.
Corresponds to the value of the
`browser.urlbar.suggest.quicksuggest.nonsponsored` pref.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
send_in_pings:
- events
pref_suggest_sponsored:
lifetime: application
type: boolean
description: >
Whether sponsored quick suggest results are shown in the urlbar.
Corresponds to the value of the
`browser.urlbar.suggest.quicksuggest.sponsored` pref.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
send_in_pings:
- events
pref_suggest_topsites:
lifetime: application
type: boolean
description: >
Whether topsite results are enabled in the urlbar.
Corresponds to the value of the `browser.urlbar.suggest.topsites` pref.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
expires: never
send_in_pings:
- events
# Replacement for PingCentre "quicksuggest-block|impression|click" pings.
quick_suggest:
ping_type:
type: string
description: >
The ping's type. In other situations might be designated by an event's
name or an interaction field. E.g. "quicksuggest-impression",
"quicksuggest-block", "quicksuggest-click".
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
position:
type: quantity
unit: QuickSuggest position
description: >
The position (1-based) of the QuickSuggest item being interatcted with.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
suggested_index:
type: string
description: >
A stringified integer value that is the intended index of the suggestion
being interacted with. If `suggested_index_relative_to_group` is true, the
index is relative to the "Firefox Suggest" group; otherwise the index is
relative to the entire list of suggestions. Non-negative values (starting
at 0) are relative to the start/top of the group/list; negative values are
relative to the end/bottom of the group/list.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
suggested_index_relative_to_group:
type: boolean
description: >
Whether `suggested_index` is relative to the "Firefox Suggest" group. If
false, it is relative to the entire list of suggestions.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
source:
type: string
description: >
The source of the interaction. E.g. "urlbar".
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
match_type:
type: string
description: >
Whether this was a best/top match or not. Either "best-match" or
"firefox-suggest".
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
block_id:
type: string
description: >
A unique identifier for the suggestion (a.k.a. a keywords block).
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
improve_suggest_experience:
type: boolean
description: >
Whether the "Improve Suggest Experience" checkbox is checked.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
advertiser:
type: string
description: >
The name of the advertiser providing the sponsored TopSite.
bugs:
data_reviews:
data_sensitivity:
- interaction
- web_activity
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
request_id:
type: string
description: >
A request identifier for each API request to
Only present for suggestions provided by Merino.
bugs:
data_reviews:
data_sensitivity:
- interaction
- web_activity
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
is_clicked:
type: boolean
description: >
Whether this quicksuggest-impression ping was for an item that was
clicked.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
reporting_url:
type: url
description: >
The url to report this interaction to.
bugs:
data_reviews:
data_sensitivity:
- web_activity
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
context_id:
type: uuid
description: >
An identifier to identify users for Contextual Services user interaction pings.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest
iab_category:
type: string
description: >
The suggestion's category. Either "22 - Shopping" or "5 - Educational".
bugs:
data_reviews:
data_sensitivity:
- interaction
- web_activity
notification_emails:
- najiang@mozilla.com
expires: never
send_in_pings:
- quick-suggest