This article introduces the datasets we maintain for search analyses:
search_clients_engines_sources_daily. After reading this article,
you should understand the search datasets well enough to produce moderately
Additionally, see the
Building Intuition search dashboards for applications to search datasets. Listed in recommended order of consumption:
- Search Monetization, an overview of how search partnerships generate revenue
- Search Mechanics, an in-depth look at the search types described below + searches with ads and ad clicks, with special attention to search behavior in important subgroups of the population
- Search Analyses, a mapping of the search datasets to corresponding Looker Explores
- Search Access Points, an overview of search, ad impressions, and ad clicks across the different search access points (SAPs) built into the browser
- Regional Search Providers, an introduction to regional search providers
Table of Contents
- Standard Search Aggregates
- In Content Telemetry Issues
- Address Bar & Search Overviews
Direct vs Follow-on Search
Searches can be split into three major classes: sap, follow-on, and organic.
SAP searches result from a direct interaction with a search access point (SAP), locations on the Firefox UI where clients can enter search queries. Searches that originate from these SAPs are often called SAP searches. For the most recent list of search access points, see Search telemetry doc as SAPs continue to be developed over time.
The Firefox browser has multiple SAPs available at the same time. For visuals noting the location of Firefox SAPs, see here. These SAPs are recorded in the
source field in search tables, and include the following:
urlbar- entering a search query in the Awesomebar. Searches typed into the search bar in the middle of the browser window will also be recorded as
urlbar-searchmode- selecting a search partner icon while entering a search query in the Awesomebar or tagging the search partner (i.e.
@duckduckgo) before entering search query via Awesomebar (was formerly called
aliasadded as of Firefox 64.)
urlbar-handoff- often referred to as new tab search. Searches by typing into the search box in the middle of the browser window will be attributed to the
urlbar-handoffstarting in Firefox 94. See more in probe dictionary and bug here.
newtab- referred to new tab search on
abouthome- referred to new tab search on
searchbar- the main search bar (on the top right corner of browser window); not present by default for new profiles on Firefox 57+.
Searchmodesearches via the
searchbarare logged as regular
contextmenu- highlight text, right click, and select "Search [search engine] for [highlighted text]" from the context menu.
system- starting Firefox from the command line with an option that immediately makes a search.
webextension- initiated from a web extension (added as of Firefox 63).
Note: Search telemetry evolves so the actual
source name used for a specific search access point may vary between different versions of Firefox. For example, to catch SAP searches performed in Awesomebar after Firefox 94, you will need to use
source in ("urlbar", "urlbar-searchmode", "urlbar-handoff").
Users will often interact with the Search Engine Results Page (SERP) to create "downstream" queries. These queries are called follow-on queries but may also be referred to as in-content queries since they are initiated from the content of the page itself and not from the Firefox UI.
For example, follow-on queries can be caused by:
- Revising a query (
restaurants near me)
- Clicking on the "next" button
- Accepting spelling suggestions
Finally, we track the number of organic searches. These searches are not via SAPs and are instead entered directly via a search engine provider, typically by visiting the provider's website and entering a search query through their website's interface.
Tagged vs Untagged Searches
Our partners (search engines) attribute queries to Mozilla using partner codes. When a user issues a query through one of our SAPs, we include our partner code in the URL of the resulting search.
Tagged queries are queries that include one of our partner codes. If a SAP query is tagged, any follow-on query should also be tagged.
Untagged queries are queries that do not include one of our partner codes. If a query is untagged, it's usually because we do not have a partner deal for that search engine and region (or it is an organic search that did not start from an SAP).
Standard Search Aggregates
We report nine types of searches in our search datasets:
unknown (although the earliest available date for each varies). These aggregates show up as columns in the
search_clients_engines_sources_daily datasets. Our search datasets are all derived from
main_summary. The aggregate columns are derived from the
sap column counts all SAP (or direct) searches.
sap search counts are collected via probes within the Firefox UI These counts are very reliable, but do not count follow-on queries.
In 2017-06 we deployed the
followonsearch addon, which adds probes for
tagged-follow-on searches. These columns attempt to count all tagged searches by looking for Mozilla partner codes in the URL of requests to partner search engines. These search counts are critical to understanding revenue since they exclude untagged searches and include follow-on searches. However, these search counts have important caveats affecting their reliability. See In Content Telemetry Issues for more information.
In 2018, we incorporated this code into the product (as of version 61) and also started tracking so-called "organic" searches that weren't initiated through a search access point (sap). This data has the same caveats as those for follow on searches, above.
We also started tracking "unknown" searches, which generally correspond to clients submitting random/unknown search data to our servers as part of their telemetry payload. This category can generally safely be ignored, unless its value is extremely high (which indicates a bug in either Firefox or the aggregation code which creates our datasets).
main_summary, all of these searches are stored in
search_counts.count, which makes it easy to over count searches. However, in general, please avoid using
main_summary for search analyses -- it's slow and you will need to duplicate much of the work done to make analyses of our search datasets tractable.
We remove search count observations representing more than 10,000 searches for a single search engine in a single ping.
In Content Telemetry Issues
The search code module inside Firefox (formerly implemented as an addon until version 60) implements the probe used to measure
tagged-follow-on searches and also tracks organic searches. This probe is critical to understanding our revenue. It's the only tool that gives us a view of follow-on searches and differentiates between tagged and untagged queries. However, it comes with some notable caveats.
Relies on whitelists
Firefox's search module attempts to count all tagged searches by looking for Mozilla partner codes in the URL of requests to partner search engines. To do this, it relies on a whitelist of partner codes and URL formats. The list of partner codes is incomplete and only covers a few top partners. These codes also occasionally change so there will be gaps in the data.
Additionally, changes to search engine URL formats can cause problems with our data collection. See this query for a notable example.
Limited historical data
followonsearch addon was first deployed in 2017-06. There is no
tagged-* search data available before this.
default_private_search_engine is only available starting 2019-11-19.
When speaking of search metrics, people sometimes have the
adblockers addon in mind. These type of information is available in
telemetry.clients_daily. Below we give two example queries around them, for more details please go visit the related section for these two tables.
AdBlockersDAU, and ad click to sap ratio in last 7 days
AdBlockersaverage DAU in last 7 days
Address Bar & Search Overviews
- Address Bar Overview by Marco Bonardo [Presentation / Slides] - an overview of Firefox's address bar (aka: the Awesomebar)
- Address Bar Results Ranking by Marco Bonardo [Slides] - deep-dive on how results are ranked and displayed in Firefox's address bar
- Search Engines Overview by Mark Banner [Presentation / Slides] - an overview on how search engines are included in Firefox
- Search Engine Configuration by Mark Banner [Presentation / Slides] - deep-dive on how search engines are configured and deployed in Firefox