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:
- 'Toolkit :: Reader Mode'
readermode:
view_on:
type: event
description: >
This is recorded any time Reader Mode is turned on or off.
This event was generated to correspond to the Legacy Telemetry event
readermode.view#on.
bugs: &readermode_view_bugs
data_reviews: &readermode_view_data_reviews
notification_emails: &readermode_view_emails
- kirill@getpocket.com
- sdowne@getpocket.com
expires: never
extra_keys: &readermode_view_extra
subcategory:
description: >
The broad event category for this probe. E.g. navigation
type: string
reader_time:
description: >
Time spent in Reader Mode session in seconds (whole number)
type: string
scroll_position:
description: >
Percentage of window scrolled in Reader Mode (whole number)
type: string
telemetry_mirror: Readermode_View_On
view_off:
type: event
description: >
This is recorded any time Reader Mode is turned on or off.
This event was generated to correspond to the Legacy Telemetry event
readermode.view#off.
bugs: *readermode_view_bugs
data_reviews: *readermode_view_data_reviews
notification_emails: *readermode_view_emails
expires: never
extra_keys: *readermode_view_extra
telemetry_mirror: Readermode_View_Off
button_click:
type: event
description: >
This is recorded any time a Reader Mode button is clicked.
This event was generated to correspond to the Legacy Telemetry event
readermode.button#click.
bugs:
data_reviews:
notification_emails:
- kirill@getpocket.com
- sdowne@getpocket.com
expires: never
extra_keys:
label:
description: >
The type of button clicked.
type: string
telemetry_mirror: Readermode_Button_Click