HomepageModule schema
ActivePublic
Actions

Authored by kostajh on Mar 29 2019, 2:14 AM.

Tags

Referenced Files

	F28606187: raw.txt
	Apr 10 2019, 11:27 PM

	F28504433: raw.txt
	Mar 29 2019, 2:14 AM

Subscribers

None

	{
	"description": "Logs interactions with the homepage modules on the Special:Homepage provided by the GrowthExperiments extension",
	"properties": {
	"action": {
	"type": "string",
	"required": true,
	"enum": [
	"impression",
	"hover-in",
	"hover-out",
	"link-click"
	],
	"description": "Action the user took:\n\n- impression: Module is shown to user\n\n- hover-in: User mouse pointer enters the element.\n\n- hover-out: User mouse pointer leaves the element\n\n- link-click: User clicks a link in the module"
	},
	"action_data": {
	"type": "string",
	"description": "Additional data for certain actions:\n\nFor action=link-click: symbolic name of the link being clicked. n.b. for impact module links, we will not append a number for each link in the list.\n\nFor mentorship module, we will add the mentor edit count and the unformatted timestamp that the editor was last active."
	},
	"user_id": {
	"type": "integer",
	"required": true,
	"description": "The user id."
	},
	"user_editcount": {
	"type": "integer",
	"required": true,
	"description": "The total number of edits of the user."
	},
	"module": {
	"type": "string",
	"enum": [
	"start-account",
	"start-tutorial",
	"start-userpage",
	"start-email",
	"impact",
	"help",
	"mentorship"
	],
	"required": true,
	"description": "The module the user is interacting with"
	},
	"state": {
	"type": "string",
	"enum": [
	"complete",
	"incomplete",
	"activated",
	"unactivated",
	"noemail",
	"unconfirmed",
	"confirmed"
	],
	"required": false,
	"description": "The state of the module the user is interacting with."
	},
	"is_mobile": {
	"type": "boolean",
	"required": true,
	"description": "Whether the mobile site is being used."
	},
	"homepage_pageview_token": {
	"type": "string",
	"required": true,
	"description": "One-time token per page load. This is a random user session ID that will be exported to the client-side when HomepageVisit events are recorded."
	}
	}
	}

Event Timeline

kostajh created this paste.Mar 29 2019, 2:14 AM

kostajh mentioned this in T219435: Homepage: HomepageModule schema.

kostajh mentioned this in T219583: Implement instrumentation code for HomepageModule schema.Mar 29 2019, 2:19 AM

nettrom_WMF edited the content of this paste. (Show Details)Apr 10 2019, 11:27 PM

robertsilen mentioned this in T283229: External identifiers' ID-links generated from P1630 ’formatter URL’. only point at one language-URL.May 20 2021, 10:24 AM

HomepageModule schemaActivePublicActions

Event Timeline

HomepageModule schema
ActivePublic
Actions