Skip to content

data_dictionary.md

Latest commit

 

History

History
80 lines (70 loc) · 3.07 KB

data_dictionary.md

File metadata and controls

80 lines (70 loc) · 3.07 KB

Activity Stream Pings

The Activity Stream addon sends two distinct types of pings to the backend (HTTPS POST) Onyx server :

  • a session ping that describes the ending of an Activity Stream session (lose focus event on Activity Stream), and
  • an event ping that records specific data about individual user interactions while interacting with Activity Stream

Example Activity Stream session Log

{
  "action": "activity_stream_session",
  "addon_version": "1.0.0",
  "client_id": "374dc4d8-0cb2-4ac5-a3cf-c5a9bc3c602e",
  "date": "2016-03-07",
  "ip": "10.192.171.13",
  "load_latency": 1100,
  "load_reason": "restore",
  "locale": "en-US",
  "max_scroll_depth": 145,
  "page": "newtab or timeline",
  "receive_at": 1457396660000,
  "session_duration": 1635,
  "tab_id": "1-3",
  "total_bookmarks": 19,
  "total_history_size": 9,
  "ua": "python-requests/2.9.1",
  "unload_reason": "close",
}

Example Activity Stream event Log

{
  "action": "activity_stream_event",
  "action_position": "3",
  "addon_version": "1.0.0",
  "client_id": "374dc4d8-0cb2-4ac5-a3cf-c5a9bc3c602e",
  "date": "2016-03-07",
  "event": "click or scroll or search or delete",
  "ip": "10.192.171.13",
  "locale": "en-US",
  "page": "newtab or timeline",
  "receive_at": 1457396660000,
  "source": "top sites, or bookmarks, or...",
  "tab_id": "1-3",
  "ua": "python-requests/2.9.1",
}
KEY DESCRIPTION  
action Either activity_stream_event or activity_stream_session. 1️⃣
addon_version The version of the Activity Stream addon. 1️⃣
action_position The index of the element in the source that was clicked. 1️⃣
client_id An identifier for this client. 1️⃣
event The type of event. Either ("click", "share", "delete", "more_items") 1️⃣
load_reason Either ("newtab", "refocus", "restore") and is the reason the tab was focused. 1️⃣
page Either ("newtab", "timeline"). 1️⃣
max_scroll_depth The maximum number of pixels the scroll bar was dragged in this session. 1️⃣
session_duration Defined to be the time in milliseconds between the newtab gaining and losing focus. 1️⃣
tab_id The Firefox generated unique id for the tab. 1️⃣
total_bookmarks The total number of bookmarks in the user's places db. 1️⃣
total_history_size The number of history items currently in the user's places db. 1️⃣
unload_reason The reason the Activity Stream page lost focus. 1️⃣
ver The version of the Onyx API the ping was sent to. 1️⃣
ip The IP address of the client. 2️⃣
locale The browser chrome's language (eg. en-US). 2️⃣
source Either ("recent_links", "recent_bookmarks", "frecent_links", "top_sites", "spotlight", "sidebar") and indicates what action. 2️⃣
ua The user agent string. 2️⃣
date The date in YYYY-MM-DD format. 3️⃣
timestamp The time in ms since epoch. 3️⃣

Where:

1️⃣ Firefox data
2️⃣ HTTP protocol data
3️⃣ server augmented data