-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
4512 lines (4127 loc) · 136 KB
/
openapi.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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Wikimedia
description: >
This API provides cacheable and straightforward access to Wikimedia content
and data, in machine-readable formats.
### Global Rules
- Limit your clients to no more than 200 requests/s to this API.
Each API endpoint's documentation may detail more specific usage limits.
- Set a unique `User-Agent` or `Api-User-Agent` header that
allows us to contact you quickly. Email addresses or URLs
of contact pages work well.
By using this API, you agree to Wikimedia's [Terms of
Use](https://wikimediafoundation.org/wiki/Terms_of_Use) and [Privacy
Policy](https://wikimediafoundation.org/wiki/Privacy_policy). Unless
otherwise specified in the endpoint documentation below, content accessed
via this API is licensed under the [CC-BY-SA
3.0](https://creativecommons.org/licenses/by-sa/3.0/) and
[GFDL](https://www.gnu.org/copyleft/fdl.html) licenses, and you irrevocably
agree to release modifications or additions made through this API under
these licenses. See https://www.mediawiki.org/wiki/REST_API for background
and details.
### Endpoint documentation
Please consult each endpoint's documentation for details on:
- Licensing information for the specific type of content
and data served via the endpoint.
- Stability markers to inform you about development status and
change policy, according to
[our API version policy](https://www.mediawiki.org/wiki/API_versioning).
- Endpoint specific usage limits.
version: 1.0.0
contact:
name: the Wikimedia Services team
url: http://mediawiki.org/wiki/REST_API
license:
name: Software available under the Apache 2 license
url: http://www.apache.org/licenses/LICENSE-2.0
termsOfService: https://wikimediafoundation.org/wiki/Terms_of_Use
x-apisguru-categories:
- media
x-logo:
url: https://twitter.com/Wikipedia/profile_image?size=original
x-origin:
- version: '2.0'
format: swagger
url: https://wikimedia.org/api/rest_v1/?spec
x-providerName: wikimedia.org
x-konfig-ignore:
object-with-no-properties: true
servers:
- url: https://wikimedia.org/api/rest_v1
tags:
- name: Transform
- name: Edited pages data
- name: Bytes difference data
- name: Editors data
- name: Pageviews data
- description: formula rendering
name: Math
- name: Edits data
- name: Feed content availability
- name: Legacy data
- name: Registered users data
- name: Unique devices data
paths:
/feed/availability:
get:
tags:
- Feed content availability
summary: Gets availability of featured feed content for the apps by wiki domain.
operationId: FeedContentAvailability_getByWikiDomain
description: >
Gets availability of featured feed content for the apps by wiki domain.
Stability:
[experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)
responses:
'200':
description: >-
JSON containing lists of wiki domains for which feed content is
available.
content:
application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Availability/1.0.1":
schema:
$ref: '#/components/schemas/availability'
application/problem+json:
schema:
$ref: '#/components/schemas/availability'
default:
description: Error
content:
application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Availability/1.0.1":
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
/media/math/check/{type}:
post:
tags:
- Math
summary: Check and normalize a TeX formula.
operationId: Math_checkFormula
description: >
Checks the supplied TeX formula for correctness and returns the
normalised formula representation as well as information about
identifiers. Available types are tex and inline-tex. The response
contains the `x-resource-location` header which can be used to retrieve
the render of the checked formula in one of the supported rendering
formats. Just append the value of the header to `/media/math/{format}/`
and perform a GET request against that URL.
Stability:
[stable](https://www.mediawiki.org/wiki/API_versioning#Stable).
parameters:
- description: The input type of the given formula; can be tex or inline-tex
in: path
name: type
required: true
schema:
type: string
enum:
- tex
- inline-tex
- chem
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MathCheckFormulaRequest'
required: true
responses:
'200':
description: Information about the checked formula
'400':
description: Invalid type
content:
application/json:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-amples:
- title: Mathoid - check test formula
request:
body:
q: E=mc^{2}
params:
domain: wikimedia.org
type: tex
response:
body:
checked: /.+/
success: true
headers:
cache-control: no-cache
content-type: /^application\/json/
x-resource-location: /.+/
status: 200
x-monitor: true
/media/math/formula/{hash}:
get:
tags:
- Math
summary: Get a previously-stored formula
operationId: Math_getFormulaByHash
description: >
Returns the previously-stored formula via `/media/math/check/{type}` for
the given hash.
Stability:
[stable](https://www.mediawiki.org/wiki/API_versioning#Stable).
parameters:
- description: The hash string of the previous POST data
in: path
name: hash
required: true
schema:
type: string
minLength: 1
responses:
'200':
description: Information about the checked formula
'404':
description: Data for the given hash cannot be found
content:
application/json:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
/media/math/render/{format}/{hash}:
get:
tags:
- Math
summary: Get rendered formula in the given format.
operationId: Math_renderFormulaByHash
description: >
Given a request hash, renders a TeX formula into its mathematic
representation in the given format. When a request is issued to the
`/media/math/check/{format}` POST endpoint, the response contains the
`x-resource-location` header denoting the hash ID of the POST data. Once
obtained, this endpoint has to be used to obtain the actual render.
Stability:
[stable](https://www.mediawiki.org/wiki/API_versioning#Stable).
parameters:
- description: The output format; can be svg or mml
in: path
name: format
required: true
schema:
type: string
enum:
- svg
- mml
- png
- description: The hash string of the previous POST data
in: path
name: hash
required: true
schema:
type: string
minLength: 1
responses:
'200':
description: The rendered formula
'404':
description: Unknown format or hash ID
content:
image/svg+xml:
schema:
$ref: '#/components/schemas/problem'
application/mathml+xml:
schema:
$ref: '#/components/schemas/problem'
image/png:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
default:
description: Error
content:
image/svg+xml:
schema:
$ref: '#/components/schemas/problem'
application/mathml+xml:
schema:
$ref: '#/components/schemas/problem'
image/png:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
/metrics/bytes-difference/absolute/aggregate/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}:
get:
tags:
- Bytes difference data
summary: >
Get the sum of absolute value of text bytes difference between current
edit and
previous one.
operationId: BytesDifferenceData_getAbsoluteAggregateByProjectAndDateRange
description: >
Given a Mediawiki project and a date range, returns a timeseries of
absolute bytes
difference sums. You can filter by editors-type (all-editor-types,
anonymous, group-bot,
name-bot, user) and page-type (all-page-types, content, non-content).
You can choose
between daily and monthly granularity as well.
- Stability:
[experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)
- Rate limit: 25 req/s
- License: Data accessible via this endpoint is available under the
[CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).
parameters:
- description: >
The name of any Wikimedia project formatted like {language
code}.{project name},
for example en.wikipedia. You may pass en.wikipedia.org and the .org
will be stripped
off. For projects like commons without language codes, use
commons.wikimedia. For
projects like www.mediawiki.org, you can use that full string, or
just use mediawiki
or mediawiki.org. If you're interested in the aggregation of all
projects, use
all-projects.
in: path
name: project
required: true
schema:
type: string
- description: >
If you want to filter by editor-type, use one of anonymous,
group-bot (registered
accounts belonging to the bot group), name-bot (registered accounts
not belonging to
the bot group but having bot-like names) or user (registered account
not in bot group
nor having bot-like name). If you are interested in edits regardless
of their
editor-type, use all-editor-types.
in: path
name: editor-type
required: true
schema:
type: string
enum:
- all-editor-types
- anonymous
- group-bot
- name-bot
- user
- description: >
If you want to filter by page-type, use one of content (edits on
pages in content
namespaces) or non-content (edits on pages in non-content
namespaces). If you are
interested in edits regardless of their page-type, use
all-page-types.
in: path
name: page-type
required: true
schema:
type: string
enum:
- all-page-types
- content
- non-content
- description: >
Time unit for the response data. As of today, supported values are
daily and monthly
in: path
name: granularity
required: true
schema:
type: string
enum:
- daily
- monthly
- description: The date of the first day to include, in YYYYMMDD format
in: path
name: start
required: true
schema:
type: string
- description: The date of the last day to include, in YYYYMMDD format
in: path
name: end
required: true
schema:
type: string
responses:
'200':
description: The list of values
content:
application/json:
schema:
$ref: >-
#/components/schemas/BytesDifferenceDataGetAbsoluteAggregateByProjectAndDateRangeResponse
application/problem+json:
schema:
$ref: '#/components/schemas/absolute-bytes-difference'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
/metrics/bytes-difference/absolute/per-page/{project}/{page-title}/{editor-type}/{granularity}/{start}/{end}:
get:
tags:
- Bytes difference data
summary: Get the sum of absolute text bytes difference per page.
operationId: BytesDifferenceData_getAbsolutePerPage
description: >
Given a Mediawiki project, a page-title prefixed with canonical
namespace (for
instance 'User:Jimbo_Wales') and a date range, returns a timeseries of
bytes
difference absolute sums. You can filter by editors-type
(all-editor-types, anonymous,
group-bot, name-bot, user). You can choose between daily and monthly
granularity as well.
- Stability:
[experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)
- Rate limit: 25 req/s
- License: Data accessible via this endpoint is available under the
[CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).
parameters:
- description: >
The name of any Wikimedia project formatted like {language
code}.{project name},
for example en.wikipedia. You may pass en.wikipedia.org and the .org
will be stripped
off. For projects like commons without language codes, use
commons.wikimedia. For
projects like www.mediawiki.org, you can use that full string, or
just use mediawiki
or mediawiki.org.
in: path
name: project
required: true
schema:
type: string
- description: >
The page-title to request absolute bytes-difference for. Should be
prefixed with the
page canonical namespace.
in: path
name: page-title
required: true
schema:
type: string
- description: >
If you want to filter by editor-type, use one of anonymous,
group-bot (registered
accounts belonging to the bot group), name-bot (registered accounts
not belonging to
the bot group but having bot-like names) or user (registered account
not in bot group
nor having bot-like name). If you are interested in edits regardless
of their
editor-type, use all-editor-types.
in: path
name: editor-type
required: true
schema:
type: string
enum:
- all-editor-types
- anonymous
- group-bot
- name-bot
- user
- description: >
Time unit for the response data. As of today, supported values are
daily and monthly
in: path
name: granularity
required: true
schema:
type: string
enum:
- daily
- monthly
- description: The date of the first day to include, in YYYYMMDD format
in: path
name: start
required: true
schema:
type: string
- description: The date of the last day to include, in YYYYMMDD format
in: path
name: end
required: true
schema:
type: string
responses:
'200':
description: The list of values
content:
application/json:
schema:
$ref: >-
#/components/schemas/BytesDifferenceDataGetAbsolutePerPageResponse
application/problem+json:
schema:
$ref: '#/components/schemas/absolute-bytes-difference-per-page'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
/metrics/bytes-difference/net/aggregate/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}:
get:
tags:
- Bytes difference data
summary: >-
Get the sum of net text bytes difference between current edit and
previous one.
operationId: BytesDifferenceData_getNetAggregateByProjectAndDateRange
description: >
Given a Mediawiki project and a date range, returns a timeseries of
bytes difference net
sums. You can filter by editors-type (all-editor-types, anonymous,
group-bot, name-bot,
user) and page-type (all-page-types, content or non-content). You can
choose between
daily and monthly granularity as well.
- Stability:
[experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)
- Rate limit: 25 req/s
- License: Data accessible via this endpoint is available under the
[CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).
parameters:
- description: >
The name of any Wikimedia project formatted like {language
code}.{project name},
for example en.wikipedia. You may pass en.wikipedia.org and the .org
will be stripped
off. For projects like commons without language codes, use
commons.wikimedia. For
projects like www.mediawiki.org, you can use that full string, or
just use mediawiki
or mediawiki.org. If you're interested in the aggregation of all
projects, use
all-projects.
in: path
name: project
required: true
schema:
type: string
- description: >
If you want to filter by editor-type, use one of anonymous,
group-bot (registered
accounts belonging to the bot group), name-bot (registered accounts
not belonging to
the bot group but having bot-like names) or user (registered account
not in bot group
nor having bot-like name). If you are interested in edits regardless
of their
editor-type, use all-editor-types.
in: path
name: editor-type
required: true
schema:
type: string
enum:
- all-editor-types
- anonymous
- group-bot
- name-bot
- user
- description: >
If you want to filter by page-type, use one of content (edits on
pages in content
namespaces) or non-content (edits on pages in non-content
namespaces). If you are
interested in edits regardless of their page-type, use
all-page-types.
in: path
name: page-type
required: true
schema:
type: string
enum:
- all-page-types
- content
- non-content
- description: >
Time unit for the response data. As of today, supported values are
daily and monthly
in: path
name: granularity
required: true
schema:
type: string
enum:
- daily
- monthly
- description: The date of the first day to include, in YYYYMMDD format
in: path
name: start
required: true
schema:
type: string
- description: The date of the last day to include, in YYYYMMDD format
in: path
name: end
required: true
schema:
type: string
responses:
'200':
description: The list of values
content:
application/json:
schema:
$ref: >-
#/components/schemas/BytesDifferenceDataGetNetAggregateByProjectAndDateRangeResponse
application/problem+json:
schema:
$ref: '#/components/schemas/net-bytes-difference'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
/metrics/bytes-difference/net/per-page/{project}/{page-title}/{editor-type}/{granularity}/{start}/{end}:
get:
tags:
- Bytes difference data
summary: Get the sum of net text bytes difference per page.
operationId: BytesDifferenceData_getSumNetTextBytesDifferencePerPage
description: >
Given a Mediawiki project, a page-title prefixed with canonical
namespace (for
instance 'User:Jimbo_Wales') and a date range, returns a timeseries of
bytes
difference net sums. You can filter by editors-type (all-editor-types,
anonymous,
group-bot, name-bot, user). You can choose between daily and monthly
granularity as well.
- Stability:
[experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)
- Rate limit: 25 req/s
- License: Data accessible via this endpoint is available under the
[CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).
parameters:
- description: >
The name of any Wikimedia project formatted like {language
code}.{project name},
for example en.wikipedia. You may pass en.wikipedia.org and the .org
will be stripped
off. For projects like commons without language codes, use
commons.wikimedia. For
projects like www.mediawiki.org, you can use that full string, or
just use mediawiki
or mediawiki.org.
in: path
name: project
required: true
schema:
type: string
- description: >
The page-title to request net bytes-difference for. Should be
prefixed with the
page canonical namespace.
in: path
name: page-title
required: true
schema:
type: string
- description: >
If you want to filter by editor-type, use one of anonymous,
group-bot (registered
accounts belonging to the bot group), name-bot (registered accounts
not belonging to
the bot group but having bot-like names) or user (registered account
not in bot group
nor having bot-like name). If you are interested in edits regardless
of their
editor-type, use all-editor-types.
in: path
name: editor-type
required: true
schema:
type: string
enum:
- all-editor-types
- anonymous
- group-bot
- name-bot
- user
- description: >
Time unit for the response data. As of today, supported values are
daily and monthly
in: path
name: granularity
required: true
schema:
type: string
enum:
- daily
- monthly
- description: The date of the first day to include, in YYYYMMDD format
in: path
name: start
required: true
schema:
type: string
- description: The date of the last day to include, in YYYYMMDD format
in: path
name: end
required: true
schema:
type: string
responses:
'200':
description: The list of values
content:
application/json:
schema:
$ref: >-
#/components/schemas/BytesDifferenceDataGetSumNetTextBytesDifferencePerPageResponse
application/problem+json:
schema:
$ref: '#/components/schemas/net-bytes-difference-per-page'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
/metrics/edited-pages/aggregate/{project}/{editor-type}/{page-type}/{activity-level}/{granularity}/{start}/{end}:
get:
tags:
- Edited pages data
summary: Get edited-pages counts for a project.
operationId: EditedPagesData_getAggregateByProjectAndDateRange
description: >
Given a Mediawiki project and a date range, returns a timeseries of its
edited-pages counts.
You can filter by editor-type (all-editor-types, anonymous, group-bot,
name-bot, user),
page-type (all-page-types, content or non-content) or activity-level
(1..4-edits,
5..24-edits, 25..99-edits, 100..-edits). You can choose between daily
and monthly
granularity as well.
- Stability:
[experimental](https://www.mediawiki.org/wiki/API_versioning#Experimental)
- Rate limit: 25 req/s
- License: Data accessible via this endpoint is available under the
[CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).
parameters:
- description: >
The name of any Wikimedia project formatted like {language
code}.{project name},
for example en.wikipedia. You may pass en.wikipedia.org and the .org
will be stripped
off. For projects like commons without language codes, use
commons.wikimedia.
For projects like www.mediawiki.org, you can use that full string,
or just use
mediawiki or mediawiki.org.
in: path
name: project
required: true
schema:
type: string
- description: >
If you want to filter by editor-type, use one of anonymous,
group-bot (registered
accounts belonging to the bot group), name-bot (registered accounts
not belonging to
the bot group but having bot-like names) or user (registered account
not in bot group
nor having bot-like name). If you are interested in edits regardless
of their
editor-type, use all-editor-types.
in: path
name: editor-type
required: true
schema:
type: string
enum:
- all-editor-types
- anonymous
- group-bot
- name-bot
- user
- description: >
If you want to filter by page-type, use one of content (edited-pages
in content
namespaces) or non-content (edited-pages in non-content namespaces).
If you are
interested in edited-pages regardless of their page-type, use
all-page-types.
in: path
name: page-type
required: true
schema:
type: string
enum:
- all-page-types
- content
- non-content
- description: >
If you want to filter by activity-level, use one of 1..4-edits,
5..24-edits,
25..99-edits or 100..-edits. If you are interested in edited-pages
regardless
of their activity level, use all-activity-levels.
in: path
name: activity-level
required: true
schema:
type: string
enum:
- all-activity-levels
- 1..4-edits
- 5..24-edits
- 25..99-edits
- 100..-edits
- description: >
The time unit for the response data. As of today, supported values
are
daily and monthly.
in: path
name: granularity
required: true
schema:
type: string
enum:
- daily
- monthly
- description: The date of the first day to include, in YYYYMMDD format
in: path
name: start
required: true
schema:
type: string
- description: The date of the last day to include, in YYYYMMDD format
in: path
name: end
required: true
schema:
type: string
responses:
'200':
description: The list of values
content:
application/json:
schema:
$ref: >-
#/components/schemas/EditedPagesDataGetAggregateByProjectAndDateRangeResponse
application/problem+json:
schema:
$ref: '#/components/schemas/edited-pages'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/problem'
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
/metrics/edited-pages/new/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}:
get:
tags:
- Edited pages data
summary: Get new pages counts for a project.
operationId: EditedPagesData_getNewPagesCountsForProject
description: >
Given a Mediawiki project and a date range, returns a timeseries of its
new pages counts.
You can filter by editor type (all-editor-types, anonymous, group-bot,
name-bot, user)