diff --git a/docs/metrics.md b/docs/metrics.md new file mode 100644 index 000000000..40660f083 --- /dev/null +++ b/docs/metrics.md @@ -0,0 +1,145 @@ +# Pings + +## Events + +
+
+    
+        
+        
+        
+        
+        
+        
+    
+    
+        
+        
+        
+        
+        
+        
+    
+    
+        
+        
+        
+        
+        
+        
+    
+    
+        
+        
+        
+        
+        
+        
+    
+    
+        
+        
+        
+        
+        
+        
+    
+    
+        
+        
+        
+        
+        
+        
+    
+    
+        
+        
+        
+        
+        
+        
+    
+    
+        
+        
+        
+        
+        
+        
+    
+    
+        
+        
+        
+        
+        
+        
+    
+    
+        
+        
+        
+        
+        
+        
+    
+    
+        
+        
+        
+        
+        
+        
+    
+
keytypedescriptiondata deviewextrasexpires
app_openedeventA user opened the applink
+            
+                
+            
sourceThe method used to open Fenix. Possible values are: `app_icon`, `custom_tab` or `link`

+        		2020-03-01
search_bar_tappedeventA user tapped the search barlink
+            
+                
+            
sourceThe view the user was on when they initiated the search (For example: `Home` or `Browser`)

+        		2020-03-01
entered_urleventA user entered a urllink
+            
+                
+            
autocompleteA boolean that tells us whether the URL was autofilled by an Autocomplete suggestion

+        		2020-03-01
performed_searcheventA user performed a searchlink
+            
+                
+                    
+                    
+                
+            
description
+                        
A string that tells us how the user performed the search. Possible values are:

+                        
                        
+                            
  • default.action
    • 
+                            
  • default.suggestion
    • 
+                            
  • shortcut.action
    • 
+                            
  • shortcut.suggestion
    • 
+                        

+                    

+        		2020-03-01
browser_menu_actioneventA browser menu item was tappedlink
+            
+                
+            
itemA string containing the name of the item the user tapped. These items include:
+Settings, Library, Help, Desktop Site toggle on/off, Find in Page, New Tab,
+Private Tab, Share, Report Site Issue, Back/Forward button, Reload Button

+        		2020-03-01
ss_menu_openedeventA user opened the search shortcut menu in the search view by pressing the shortcuts buttonlink2020-03-01
ss_menu_closedevent A user closed the search shortcut menu in the search view by pressing the shortcuts buttonlink2020-03-01
ss_selectedeventA user selected a search shortcut engine to uselink
+            
+                
+            
engineThe name of the built-in search engine the user selected as a string

+        		2020-03-01
total_uri_countcounterA counter of URIs visited by the user in the current session, including page reloads. This does not include background page requests and URIs from embedded pages or private browsing.link2020-03-01
preference_toggledeventA user toggled a preference switch in settingslink
+            
+                
+                
+                
+            
preference_keyThe preference key for the switch preference the user toggled. We currently track: leakcanary,
+make_default_browser, show_search_suggestions, show_visited_sites_bookmarks, remote_debugging, telemetry,
+tracking_protection
enabledWhether or not the preference is now enabled

+        		2020-03-01

+
+ +#### app_opened + +## Metrics