/
1.0.0.yaml
150 lines (142 loc) · 4.71 KB
/
1.0.0.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
title: analytics/mediawiki/wikistories_contribution_event
description: >
An event related to the creation or editing of story content from
Extension:Wikistories. A "story" is essentially a slideshow of images with
superimposed text; a "frame" is one of the individual slides.
$id: /analytics/mediawiki/wikistories_contribution_event/1.0.0
$schema: 'https://json-schema.org/draft-07/schema#'
type: object
required:
- $schema
- access_method
- event_type
- meta
- story_already_exists
- user_is_anonymous
properties:
$schema:
description: >
A URI identifying the JSONSchema for this event. This should match an
schema's $id in a schema repository. E.g. /schema/title/1.0.0
type: string
access_method:
description: >
Which interface the user is using to access the wiki. Note that "mobile
web" uses a space rather than an underscore.
type: string
enum:
- desktop
- mobile web
context_page_title:
description: >
The name of the page where the user followed the link to the story
builder. Null if the user accessed the story builder directly, without
passing through a context page.
type: string
event_type:
description: >
The type of event that occured:
* story_builder_open: The user opens the story editing interface.
* add_frame: The user adds a new frame to the story. Currently, this
happens when the user adds an image to the story, which becomes a new
frame. Multiple images can be added at once, but this should only result
in a single event.
* remove_frame: The user deletes a frame from the story.
* replace_image: The user replaces an image already used in the story.
* import_text: The user imports text from an article into a frame.
* edit_text: The user edits the text in a frame. Logged when the user
leaves a text box having made/saved a change.
* publish_failure: The user's publish attempt fails due to an invalid
title, AbuseFilter or other publication limit.
* publish_success: The user's publish attempt succeeds and the story is
published.
type: string
enum:
- story_builder_open
- add_frame
- remove_frame
- replace_image
- import_text
- edit_text
- publish_failure
- publish_success
meta:
type: object
required:
- dt
- stream
properties:
domain:
description: Domain the event or entity pertains to
type: string
minLength: 1
dt:
description: 'UTC event datetime, in ISO-8601 format'
type: string
format: date-time
maxLength: 128
id:
description: Unique ID of this event
type: string
request_id:
description: Unique ID of the request that caused the event
type: string
stream:
description: Name of the stream/queue/dataset that this event belongs in
type: string
minLength: 1
uri:
description: Unique URI identifying the event or entity
type: string
format: uri-reference
maxLength: 8192
publish_failure_message:
description: >
The content of the explanatory message shown to the user after a publish
attempt fails. Applies only to publish_failure events.
type: string
story_already_exists:
description: >
Whether the user is editing a story that already exists. If false, the
user is attempting to create a new story.
type: boolean
story_title:
description: >
The name of the current story. Since the name is only chosen at the end of
the creation process, this will only applied to publish_success events or
if editing an existing story.
type: string
user_edit_count_bucket:
description: >
The range in which the user's edit count on the wiki falls. Null if the
user is anonymous. Avaiable in the `wgUserEditCountBucket` config
variable.
type: string
enum:
- '0'
- 1-4
- 5-99
- 10-99
- 100-999
- 1000+
user_is_anonymous:
description: Whether the user is anonymous (unregistered) or registered.
type: boolean
user_name:
description: |
The name of the user. Null for anonymous users.
type: string
examples:
- $schema: /analytics/mediawiki/wikistories_contribution_event/1.0.0
access_method: mobile web
context_page_title: Istanbul
event_type: publish_success
meta:
domain: id.m.wikipedia.org
dt: '2022-10-03T03:22:01.187Z'
stream: mediawiki.wikistories_contribution_event
story_already_exists: false
story_title: Kucing_Istanbul
user_edit_count_bucket: 100-999
user_is_anonymous: false
user_name: PecintaKucing38