User:Roan Kattouw (WMF)/Draft help panel schema.json

From Meta, a Wikimedia project coordination wiki
Jump to navigation Jump to search

Note: After saving, you may have to bypass your browser's cache to see the changes.

  • Firefox / Safari: Hold Shift while clicking Reload, or press either Ctrl-F5 or Ctrl-R (⌘-R on a Mac)
  • Google Chrome: Press Ctrl-Shift-R (⌘-Shift-R on a Mac)
  • Internet Explorer: Hold Ctrl while clicking Refresh, or press Ctrl-F5
  • Opera: Go to Menu → Settings (Opera → Preferences on a Mac) and then to Privacy & security → Clear browsing data → Cached images and files.
description"Logs interactions with the help panel displayed to new editors by the GrowthExperiments extension"
properties
version
type"integer"
requiredtrue
description"Version number. This field can be used to track changes in instrumentation that affect the nature of the data collected."
is_oversample
description"Whether this request is an oversample, or a standard sample."
type"boolean"
action
type"string"
requiredtrue
enum
"impression"
"open"
"close"
"review"
"back-home"
"link-click"
"enter-question-text"
"submit-attempt"
"submit-success"
"submit-failure"
description"Action the user took: impression: Help button is shown to user open: User opens panel close: User closes panel review: User advances from the home panel to the question review panel back-home: User goes back from the question review panel to the home panel link-click: User clicks a link in the panel enter-question-text: User enters text into the question field submit-attempt: User clicks the button to submit their question submit-success: Question is successfully submitted submit-failure: Question submission fails"
action_data
type"string"
description"Additional data for certain actions: For action=link-click: symbolic name of the link being clicked For action=submit-success: revision ID of the edit adding the question"
user_id
type"integer"
requiredtrue
description"The user id (0 if logged out)."
user_editcount
type"integer"
requiredtrue
description"The total number of edits of the user."
editor_interface
type"string"
enum
"visualeditor"
"wikitext-2017"
"wikitext"
"other"
requiredtrue
description"The editor interface through which the user is attempting to edit the page."
platform
type"string"
enum
"desktop"
"tablet"
"phone"
"other"
requiredtrue
description"The editing device through which the user is attempting to edit the page."
page_id
type"integer"
requiredtrue
description"ID of the page the user is attempting to edit."
page_title
type"string"
requiredtrue
description"Full title of the page the user is attempting to edit, including namespace (wgPageName format). This is needed to log edit activity on redlinks, as pageId and revId are not available."
page_ns
type"integer"
requiredtrue
description"Namespace ID of the page the user is attempting to edit."
user_can_edit
type"boolean"
requiredtrue
description"Whether the user is allowed to edit the page. This will be false if e.g. the page is protected or the user is blocked."
page_edit_protection
type"string"
description"For protected pages, the permission level required to edit the page. Unset for unprotected pages."
page_token
type"string"
requiredtrue
description"One-time token per page load (consistent with Schema:PageIssues and other schemas that use https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.user-method-getPageviewToken ). This will only be set for client-side (JavaScript-generated) events, for server-side events the value will be an empty string."
session_token
type"string"
requiredtrue
description"Session token that survives across pages (mw.user.sessionId()), but not browser restarts, used in deterministic user bucketing. This will only be set for client-side (JavaScript-generated) events, for server-side events the value will be an empty string."