action | description | "Which particular action triggered this event:
- highlight: the user highlighted some text in the web view
- sharetap: the user tapped the share button in the UI
- shareintent: the user has tapped either 'Share as image' or 'Share as text'
- abandoned: the user was shown 'Share as text' and 'Share as image', but they cancelled and chose neither
- share: the user successfully shared the content (note: this action is not recorded on Android due to technical limitations)
- failure: the user tapped share and the share was handed off to another app, but the user either cancelled or there was an error with the sharing process" |
---|
enum | "highlight" |
"sharetap" |
"shareintent" |
"abandoned" |
"share" |
"failure" |
|
---|
type | "string" |
---|
required | true |
---|
|
---|
share_mode | description | "Whether the user tapped 'Share as image' or 'Share as text'. Sent with shareintent events and share events." |
---|
enum | |
---|
type | "string" |
---|
required | false |
---|
|
---|
text | description | "The text that was highlighted. Sent with hightlight events. Also sent with sharetap, shareintent, abandoned and share actions if the user has highlighted text." |
---|
type | "string" |
---|
required | false |
---|
|
---|
target | description | "The service or platform the text was shared to (e.g. Twitter); sent with share actions.
(Note: This may not be recorded on Android due to technical limitations.)" |
---|
type | "string" |
---|
required | false |
---|
|
---|
article | description | "The title of the article the user is currently on." |
---|
type | "string" |
---|
required | true |
---|
|
---|
page_id | description | "The page ID of the article the user is currently on." |
---|
type | "integer" |
---|
required | true |
---|
|
---|
rev_id | description | "The revision of the article the user is currently on." |
---|
type | "integer" |
---|
required | true |
---|
|
---|
tutorial_feature_enabled | description | "Whether tool tip tutorials were enabled or not." |
---|
type | "boolean" |
---|
required | true |
---|
|
---|
tutorial_shown | description | "The tutorials shown where 0 = none, 1 = long press to select text, and 2 = share." |
---|
type | "integer" |
---|
required | true |
---|
|
---|
session_token | description | "Session token for this sharing funnel." |
---|
type | "string" |
---|
required | true |
---|
|
---|
app_install_id | description | "Randomly generated UUID that is unique to each app install, which can be used to cross-reference the same app install across different schemas." |
---|
type | "string" |
---|
required | true |
---|
|
---|
client_dt | description | "Client-side ISO-8601-formatted date-time at which this event occurred." |
---|
type | "string" |
---|
required | true |
---|
|
---|