Page MenuHomePhabricator

Image instrumentation: onboarding
Closed, ResolvedPublic

Description

Corresponding task from "add a link": T278111: Instrumentation: Onboarding
Associated feature: T292092: Add an image: overlay onboarding


After a user selects a task, they are presented with four sequential onboarding screens. For each screen, we need to record:

  • Impressions
  • When the user advances back or forward through the screens.
  • When the user closes the onboarding with the “Skip all” button. This event should also store whether the “Don’t show again” checkbox was selected.
  • When the user closes the onboarding with the “Get started” button. This event should also store whether the “Don’t show again” checkbox was selected.
  • When the user clicks the “Learn more” link.

Event Timeline

@MMiller_WMF - should we also track if a person abandons the task at any point in the onboarding? (e.g., by navigating away by selecting browser back, or closing the onboarding and then exiting the task)

Sample events:

Impression

event: {
  "action": "impression",
  "action_data": "dont_show_again=false",
  "is_mobile": false,
  "newcomer_task_token": "337e13e1a72b0df8f72f",
  "page_id": 1789,
  "page_title": "Edward Edwards (Royal Navy officer)",
  "homepage_pageview_token": "72m6n8oucscqptdv2rtsjec80p5qgrar",
  "active_interface": "onboarding_step_1_dialog",
  "$schema": "/analytics/mediawiki/structured_task/article/image_suggestion_interaction/1.1.0",
  "meta": {
    "stream": "mediawiki.structured_task.article.image_suggestion_interaction",
    "domain": "192.168.86.22"
  },
  "dt": "2021-11-01T20:08:16.551Z"
}

Learn more link click

event: {
  "action": "link_click",
  "action_data": "dont_show_again=false",
  "is_mobile": false,
  "newcomer_task_token": "337e13e1a72b0df8f72f",
  "page_id": 1789,
  "page_title": "Edward Edwards (Royal Navy officer)",
  "homepage_pageview_token": "72m6n8oucscqptdv2rtsjec80p5qgrar",
  "active_interface": "onboarding_step_1_dialog",
  "$schema": "/analytics/mediawiki/structured_task/article/image_suggestion_interaction/1.1.0",
  "meta": {
    "stream": "mediawiki.structured_task.article.image_suggestion_interaction",
    "domain": "192.168.86.22"
  },
  "dt": "2021-11-01T20:10:44.725Z"
}

Skip all (with Don't show again checked)

event: {
  "action": "skip_all",
  "action_data": "dont_show_again=true",
  "is_mobile": false,
  "newcomer_task_token": "337e13e1a72b0df8f72f",
  "page_id": 1789,
  "page_title": "Edward Edwards (Royal Navy officer)",
  "homepage_pageview_token": "72m6n8oucscqptdv2rtsjec80p5qgrar",
  "active_interface": "onboarding_step_1_dialog",
  "$schema": "/analytics/mediawiki/structured_task/article/image_suggestion_interaction/1.1.0",
  "meta": {
    "stream": "mediawiki.structured_task.article.image_suggestion_interaction",
    "domain": "192.168.86.22"
  },
  "dt": "2021-11-01T20:12:08.851Z"
}

Get started (with Don't show again checked)

event: {
  "action": "get_started",
  "action_data": "dont_show_again=true",
  "is_mobile": false,
  "newcomer_task_token": "f0e0ac8fb09ea01989ed",
  "page_id": 1789,
  "page_title": "Edward Edwards (Royal Navy officer)",
  "homepage_pageview_token": "1ntf6pi1gjbr7nhlpis3018cnuooieu1",
  "active_interface": "onboarding_step_4_dialog",
  "$schema": "/analytics/mediawiki/structured_task/article/image_suggestion_interaction/1.1.0",
  "meta": {
    "stream": "mediawiki.structured_task.article.image_suggestion_interaction",
    "domain": "192.168.86.22"
  },
  "dt": "2021-11-01T20:18:01.030Z"
}

@MMiller_WMF - should we also track if a person abandons the task at any point in the onboarding? (e.g., by navigating away by selecting browser back, or closing the onboarding and then exiting the task)

@RHo -- I don't know that we tend to explicitly track that sort of thing, or rather we infer it based on the user not having the next event.

@nettrom_WMF -- what is your preference here?

Change 736071 had a related patch set uploaded (by MewOphaswongse; author: MewOphaswongse):

[mediawiki/extensions/GrowthExperiments@master] Add an image: Instrumentation parity with Add Link

https://gerrit.wikimedia.org/r/736071

Change 736071 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] Add an image: Instrumentation parity with Add Link

https://gerrit.wikimedia.org/r/736071

@MMiller_WMF - should we also track if a person abandons the task at any point in the onboarding? (e.g., by navigating away by selecting browser back, or closing the onboarding and then exiting the task)

@RHo -- I don't know that we tend to explicitly track that sort of thing, or rather we infer it based on the user not having the next event.

@nettrom_WMF -- what is your preference here?

I think we'll probably run into more problems if we define events for this and then expect them to be sent (e.g. are we sure we'll get events if the user closes the browser window?) Currently we'd infer this based on the next event, like you wrote, and then if need be create funnel stats that shows where users drop out of the expected workflow. Similarly, we'd identify if a user abandons the task by that task's session id having the task click event but no saved edit.

@MMiller_WMF - should we also track if a person abandons the task at any point in the onboarding? (e.g., by navigating away by selecting browser back, or closing the onboarding and then exiting the task)

@RHo -- I don't know that we tend to explicitly track that sort of thing, or rather we infer it based on the user not having the next event.

@nettrom_WMF -- what is your preference here?

I think we'll probably run into more problems if we define events for this and then expect them to be sent (e.g. are we sure we'll get events if the user closes the browser window?) Currently we'd infer this based on the next event, like you wrote, and then if need be create funnel stats that shows where users drop out of the expected workflow. Similarly, we'd identify if a user abandons the task by that task's session id having the task click event but no saved edit.

Sounds good, thanks for the explanation!

Checked in betalabs - all events are present; the info recorded match the info in Mew's comment.

Moving to Test in Production for @nettrom_WMF to verify.

Based on the investigations done for T297138, the onboarding events are all recorded correctly. Closing as resolved.