-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathschema.graphql
More file actions
2572 lines (2479 loc) · 88 KB
/
schema.graphql
File metadata and controls
2572 lines (2479 loc) · 88 KB
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
schema {
query: Query
}
scalar Boolean
scalar Float
scalar ID
scalar Int
scalar JSON
scalar String
type Query {
# Obtain the character data object that allows the retrieval of individual
# characters or filtered collections of characters.
characterData: CharacterData
# Obtain the game data object that holds collections of static data such as
# abilities, achievements, classes, items, NPCs, etc..
gameData: GameData
# Obtain the guild data object that allows the retrieval of individual guilds or
# filtered collections of guilds.
guildData: GuildData
# Obtain information about an ongoing world first or realm first race. Inactive
# when no race is occurring. This data only updates once every 30 seconds, so you
# do not need to fetch this information more often than that.
progressRaceData: ProgressRaceData
# Obtain the rate limit data object to see how many points have been spent by this
# key.
rateLimitData: RateLimitData
# Obtain the report data object that allows the retrieval of individual reports or
# filtered collections of reports by guild or by user.
reportData: ReportData
# Obtain the user object that allows the retrieval of the authorized user's id and
# username.
userData: UserData
# Obtain the world data object that holds collections of data such as all
# expansions, regions, subregions, servers, dungeon/raid zones, and encounters.
worldData: WorldData
}
enum CharacterRankingMetricType {
# Boss cDPS is unique to FFXIV and is damage done to the boss adjusted for
# raid-contributing buffs and debuffs.
bosscdps
# Boss damage per second.
bossdps
# Boss nDPS is unique to FFXIV and is damage done to the boss adjusted for
# raid-contributing buffs and debuffs.
bossndps
# Boss rDPS is unique to FFXIV and is damage done to the boss adjusted for
# raid-contributing buffs and debuffs.
bossrdps
# Choose an appropriate default depending on the other selected parameters.
default
# Damage per second.
dps
# Healing per second.
hps
# Survivability ranking for tanks. Deprecated. Only supported for some older WoW
# zones.
krsi
# Score. Used by WoW Mythic dungeons and by ESO trials.
playerscore
# Speed. Not supported by every zone.
playerspeed
# cDPS is unique to FFXIV and is damage done adjusted for raid-contributing buffs
# and debuffs.
cdps
# nDPS is unique to FFXIV and is damage done adjusted for raid-contributing buffs
# and debuffs.
ndps
# rDPS is unique to FFXIV and is damage done adjusted for raid-contributing buffs
# and debuffs.
rdps
# Healing done per second to tanks.
tankhps
# Weighted damage per second. Unique to WoW currently. Used to remove pad damage
# and reward damage done to high priority targets.
wdps
# Unique to FFXIV. Represents the combined ranking for a pair of healers in eight
# player content.
healercombineddps
# Unique to FFXIV. Represents the combined ranking for a pair of healers in eight
# player content.
healercombinedbossdps
# Unique to FFXIV. Represents the combined ranking for a pair of healers in eight
# player content.
healercombinedcdps
# Unique to FFXIV. Represents the combined ranking for a pair of healers in eight
# player content.
healercombinedbosscdps
# Unique to FFXIV. Represents the combined ranking for a pair of healers in eight
# player content.
healercombinedndps
# Unique to FFXIV. Represents the combined ranking for a pair of healers in eight
# player content.
healercombinedbossndps
# Unique to FFXIV. Represents the combined ranking for a pair of healers in eight
# player content.
healercombinedrdps
# Unique to FFXIV. Represents the combined ranking for a pair of healers in eight
# player content.
healercombinedbossrdps
# Unique to FFXIV. Represents the combined ranking for a pair of tanks in eight
# player content.
tankcombineddps
# Unique to FFXIV. Represents the combined ranking for a pair of tanks in eight
# player content.
tankcombinedbossdps
# Unique to FFXIV. Represents the combined ranking for a pair of tanks in eight
# player content.
tankcombinedcdps
# Unique to FFXIV. Represents the combined ranking for a pair of tanks in eight
# player content.
tankcombinedbosscdps
# Unique to FFXIV. Represents the combined ranking for a pair of tanks in eight
# player content.
tankcombinedndps
# Unique to FFXIV. Represents the combined ranking for a pair of tanks in eight
# player content.
tankcombinedbossndps
# Unique to FFXIV. Represents the combined ranking for a pair of tanks in eight
# player content.
tankcombinedrdps
# Unique to FFXIV. Represents the combined ranking for a pair of tanks in eight
# player content.
tankcombinedbossrdps
}
enum EventDataType {
# All Events
All
# Buffs.
Buffs
# Casts.
Casts
# Combatant info events (includes gear).
CombatantInfo
# Damage done.
DamageDone
# Damage taken.
DamageTaken
# Deaths.
Deaths
# Debuffs.
Debuffs
# Dispels.
Dispels
# Healing done.
Healing
# Interrupts.
Interrupts
# Resources.
Resources
# Summons
Summons
# Threat.
Threat
}
enum ExternalBuffRankFilter {
# Include all ranks, regardless of external buffs.
Any
# Only include ranks that DO CONTAIN external buffs.
Require
# Only include ranks that DO NOT CONTAIN external buffs.
Exclude
}
enum FightRankingMetricType {
# Choose an appropriate default depending on the other selected parameters.
default
# A metric that rewards minimizing deaths and damage taken.
execution
# Feats of strength in WoW or Challenges in FF.
feats
# For Mythic+ dungeons in WoW, represents the team's score. Used for ESO trials
# and dungeons also.
score
# Speed metric, based off the duration of the fight.
speed
# Progress metric, based off when the fight was defeated.
progress
}
enum GraphDataType {
# Summary Overview
Summary
# Buffs.
Buffs
# Casts.
Casts
# Damage done.
DamageDone
# Damage taken.
DamageTaken
# Deaths.
Deaths
# Debuffs.
Debuffs
# Dispels.
Dispels
# Healing done.
Healing
# Interrupts.
Interrupts
# Resources.
Resources
# Summons
Summons
# Survivability (death info across multiple pulls).
Survivability
# Threat.
Threat
}
enum GuildRank {
# The user is not a member of this guild or team.
NonMember
Applicant
Recruit
Member
Officer
GuildMaster
}
enum HardModeLevelRankFilter {
# Any hard mode level (including normal mode).
Any
# The highest hard mode level. Convenience alias for hard mode level 4.
Highest
# The normal (non-hard) mode level. Convenience alias for hard mode level 0.
NormalMode
# Hard mode level 0.
Level0
# Hard mode level 1.
Level1
# Hard mode level 2.
Level2
# Hard mode level 3.
Level3
# Hard mode level 4.
Level4
}
enum HostilityType {
# Fetch information for friendlies.
Friendlies
# Fetch information for enemies.
Enemies
}
enum KillType {
# Include trash and encounters.
All
# Only include encounters (kills and wipes).
Encounters
# Only include encounters that end in a kill.
Kills
# Only include trash.
Trash
# Only include encounters that end in a wipe.
Wipes
}
enum LeaderboardRank {
# All ranks are included.
Any
# Only include ranks with a backing log.
LogsOnly
}
enum RankingCompareType {
# Compare against rankings.
Rankings
# Compare against all parses in a two week window.
Parses
}
enum RankingTimeframeType {
# Compare against today's rankings.
Today
# Compare against historical rankings.
Historical
}
enum ReportRankingMetricType {
# Boss damage per second.
bossdps
# Boss rDPS is unique to FFXIV and is damage done to the boss adjusted for
# raid-contributing buffs and debuffs.
bossrdps
# Choose an appropriate default depending on the other selected parameters.
default
# Damage per second.
dps
# Healing per second.
hps
# Survivability ranking for tanks. Deprecated. Only supported for some older WoW
# zones.
krsi
# Score. Used by WoW Mythic dungeons and by ESO trials.
playerscore
# Speed. Not supported by every zone.
playerspeed
# rDPS is unique to FFXIV and is damage done adjusted for raid-contributing buffs
# and debuffs.
rdps
# Healing done per second to tanks.
tankhps
# Weighted damage per second. Unique to WoW currently. Used to remove pad damage
# and reward damage done to high priority targets.
wdps
}
enum RoleType {
# Fetch any role..
Any
# Fetch the DPS role only.
DPS
# Fetch the healer role only.
Healer
# Fetch the tanking role only.
Tank
}
enum SubscriptionStatus {
# Silver Tier subscription
Silver
# Gold Tier subscription
Gold
# Platinum Tier subscription
Platinum
# Legacy Silver Tier subscription
LegacySilver
@deprecated(
reason: "Legacy Silver subscriptions are not available for new users."
)
# Legacy Gold Tier subscription
LegacyGold
@deprecated(
reason: "Legacy Gold subscriptions are not available for new users."
)
# Legacy Platinum Tier subscription
LegacyPlatinum
@deprecated(
reason: "Legacy Platinum subscriptions are not available for new users."
)
# Alchemical Society Tier subscription
AlchemicalSociety
}
enum TableDataType {
# Summary Overview
Summary
# Buffs.
Buffs
# Casts.
Casts
# Damage done.
DamageDone
# Damage taken.
DamageTaken
# Deaths.
Deaths
# Debuffs.
Debuffs
# Dispels.
Dispels
# Healing done.
Healing
# Interrupts.
Interrupts
# Resources.
Resources
# Summons
Summons
# Survivability (death info across multiple pulls).
Survivability
# Threat.
Threat
}
enum ViewType {
# Use the same default that the web site picks based off the other selected
# parameters.
Default
# View by ability.
Ability
# View. by source.
Source
# View by target.
Target
}
enum __DirectiveLocation {
# Location adjacent to a query operation.
QUERY
# Location adjacent to a mutation operation.
MUTATION
# Location adjacent to a subscription operation.
SUBSCRIPTION
# Location adjacent to a field.
FIELD
# Location adjacent to a fragment definition.
FRAGMENT_DEFINITION
# Location adjacent to a fragment spread.
FRAGMENT_SPREAD
# Location adjacent to an inline fragment.
INLINE_FRAGMENT
# Location adjacent to a variable definition.
VARIABLE_DEFINITION
# Location adjacent to a schema definition.
SCHEMA
# Location adjacent to a scalar definition.
SCALAR
# Location adjacent to an object type definition.
OBJECT
# Location adjacent to a field definition.
FIELD_DEFINITION
# Location adjacent to an argument definition.
ARGUMENT_DEFINITION
# Location adjacent to an interface definition.
INTERFACE
# Location adjacent to a union definition.
UNION
# Location adjacent to an enum definition.
ENUM
# Location adjacent to an enum value definition.
ENUM_VALUE
# Location adjacent to an input object type definition.
INPUT_OBJECT
# Location adjacent to an input object field definition.
INPUT_FIELD_DEFINITION
}
enum __TypeKind {
# Indicates this type is a scalar.
SCALAR
# Indicates this type is an object. `fields` and `interfaces` are valid fields.
OBJECT
# Indicates this type is an interface. `fields`, `interfaces`, and `possibleTypes`
# are valid fields.
INTERFACE
# Indicates this type is a union. `possibleTypes` is a valid field.
UNION
# Indicates this type is an enum. `enumValues` is a valid field.
ENUM
# Indicates this type is an input object. `inputFields` is a valid field.
INPUT_OBJECT
# Indicates this type is a list. `ofType` is a valid field.
LIST
# Indicates this type is a non-null. `ofType` is a valid field.
NON_NULL
}
type ArchonViewModels {
user: JSON
googleAnalytics: JSON
game: JSON
# Arguments
# keys: [Not documented]
translations(keys: [String]): JSON
# Arguments
# gameSlug: [Not documented]
header(gameSlug: String): JSON
headerTitle: JSON
footer: JSON
indexPage: JSON
signInPage: JSON
signOutPage: JSON
authErrorPage: JSON
accountPage: JSON
gamePage: JSON
contactPage: JSON
privacyPolicyPage: JSON
aboutPage: JSON
announcementPage: JSON
gameSlugs: JSON
buildsZonePageSlugs: JSON
# Arguments
# gameSlug: [Not documented]
# rankingsSlug: [Not documented]
# zoneTypeSlug: [Not documented]
# difficultySlug: [Not documented]
# encounterSlug: [Not documented]
# affixesSlug: [Not documented]
buildsZonePage(
gameSlug: String
rankingsSlug: String
zoneTypeSlug: String
difficultySlug: String
encounterSlug: String
affixesSlug: String
): JSON
buildsSpecPageSlugs: JSON
# Arguments
# gameSlug: [Not documented]
# classSlug: [Not documented]
# specSlug: [Not documented]
# zoneTypeSlug: [Not documented]
# categorySlug: [Not documented]
# difficultySlug: [Not documented]
# encounterSlug: [Not documented]
# affixesSlug: [Not documented]
buildsSpecPage(
gameSlug: String
classSlug: String
specSlug: String
zoneTypeSlug: String
categorySlug: String
difficultySlug: String
encounterSlug: String
affixesSlug: String
): JSON
# Arguments
# gameSlug: [Not documented]
buildsClassesAndSpecsPage(gameSlug: String): JSON
# Arguments
# id: [Not documented]
ability(id: Int): JSON
# Arguments
# articleCategorySlug: [Not documented]
articleCategory(articleCategorySlug: String): JSON
articleCategories: JSON
# Arguments
# articleCategorySlug: [Not documented]
# siteName: [Not documented]
articleSlugs(articleCategorySlug: String, siteName: String): JSON
# Arguments
# articleSlug: [Not documented]
# articleCategorySlug: [Not documented]
# siteName: [Not documented]
article(
articleSlug: String
articleCategorySlug: String
siteName: String
): JSON
# Arguments
# currentSlug: [Not documented]
cmsNavigation(currentSlug: String): JSON
# Arguments
# articleCategorySlug: [Not documented]
# pageNumber: [Not documented]
# siteName: [Not documented]
pageOfArticlePreviews(
articleCategorySlug: String
pageNumber: Int
siteName: String
): JSON
# Arguments
# snippetSlugs: [Not documented]
snippets(snippetSlugs: [String]): JSON
articleIndexPage: JSON
playwireAds: JSON
adPlacements: JSON
# Arguments
# userId: [Not documented]
# reportCode: [Not documented]
reportPage(userId: Int, reportCode: String!): JSON
# Arguments
# userId: [Not documented]
# reportCode: [Not documented]
# fightId: [Not documented]
fightPage(userId: Int, reportCode: String!, fightId: Int!): JSON
# Arguments
# characterId: [Not documented]
characterPage(characterId: Int!): JSON
# Arguments
# userId: [Not documented]
# characterId: [Not documented]
characterPageData(userId: Int, characterId: Int!): JSON
}
type Bracket {
# An integer representing the minimum value used by bracket number 1, etc.
min: Float!
# An integer representing the value used by bracket N when there are a total of N
# brackets, etc.
max: Float!
# A float representing the value to increment when moving from bracket 1 to
# bracket N, etc.
bucket: Float!
# The localized name of the bracket type.
type: String
}
type Character {
# Whether or not the character info is anonymous in the log.
anonymous: Boolean
# The canonical ID of the character. If a character renames or transfers, then the
# canonical id can be used to identify the most recent version of the character.
canonicalID: Int!
# Whether this character is claimed by the current user. Only accessible if
# accessed via the user API with the "view-user-profile" scope.
claimed: Boolean
# The class id of the character.
classID: Int!
# The display name (account) of the character.
displayName: String!
# Encounter rankings information for a character, filterable to specific zones,
# bosses, metrics, etc. This data is not considered frozen, and it can change
# without notice. Use at your own risk.
#
# Arguments
# byBracket: Optional. Whether or not to use bracket rankings
# instead of overall rankings. For WoW, brackets are item levels or keystones. For
# FF, brackets are patches.
# className: Optional. The slug for a specific class. Whether or
# not to filter rankings to a specific class. Only used by games that support
# multiple classes on a single character..
# compare: Optional. Whether or not to compare against rankings
# (best scores across the entire tier) or two weeks worth of parses (more
# representative of real-world performance).
# difficulty: Optional. Whether or not to filter the rankings to
# a specific difficulty. If omitted, the highest difficulty is used.
# encounterID: Required. The specific encounter whose rankings
# should be fetched.
# includeCombatantInfo: Optional. Whether or not to include
# detailed combatant info such as gear in the results.
# includePrivateLogs: Optional. Whether or not to include private
# logs in the results. This option is only available if using the user GraphQL
# endpoint.
# metric: Optional. You can filter to a specific character metric
# like dps or hps. If omitted, an appropriate default metric for the zone will be
# chosen.
# partition: Optional. Whether or not to filter the rankings to a
# specific partition. By default, the latest partition is chosen. A special value
# of -1 can be passed to fetch data from all partitions.
# role: Optional. The slug for a specific role. This allow you to
# only fetch ranks for the healing role, dps role or tank role.
# size: Optional. Whether or not to filter rankings to a specific
# size. If omitted, the first valid raid size will be used.
# specName: Optional. The slug for a specific spec. Whether or
# not to filter rankings to a specific spec. If omitted, data for all specs will
# be used.
# timeframe: Optional. Whether or not the returned report
# rankings should be compared against today's rankings or historical rankings
# around the time the fight occurred.
encounterRankings(
byBracket: Boolean
className: String
compare: RankingCompareType
difficulty: Int
encounterID: Int
includeCombatantInfo: Boolean
includePrivateLogs: Boolean
metric: CharacterRankingMetricType
partition: Int
role: RoleType
size: Int
specName: String
timeframe: RankingTimeframeType
): JSON
# Cached game data such as gear for the character. This data was fetched from the
# appropriate source (Blizzard APIs for WoW, Lodestone for FF). This call will
# only return a cached copy of the data if it exists already. It will not go out
# to Blizzard or Lodestone to fetch a new copy.
#
# Arguments
# specID: Optional. A specific spec ID to retrieve information
# for. If omitted, the last observed spec on Armory (WoW) or Lodestone (FF) will
# be used.
# forceUpdate: Optional. Whether or not to force the updating of
# the character before returning the game data.
gameData(specID: Int, forceUpdate: Boolean): JSON
# The guild rank of the character in their primary guild. This is not the user
# rank on the site, but the rank according to the game data, e.g., a Warcraft
# guild rank or an FFXIV Free Company rank.
guildRank: Int!
# All guilds that the character belongs to.
guilds: [Guild]
# Whether or not the character has all its rankings hidden.
hidden: Boolean!
# The ID of the character.
id: Int!
# The name of the character.
name: String!
# The race of the character.
raceID: Int!
# Recent reports for the character.
#
# Arguments
# limit: Optional. The number of recent reports to retrieve. If
# omitted, defaults to 10. The maximum allowed value is 100, and minimum allowed
# value is 1.
# page: Optional. The page of paginated data to retrieve. If
# omitted, defaults to the first page.
recentReports(limit: Int, page: Int): ReportPagination
# The server that the character belongs to.
server: Server!
# Rankings information for a character, filterable to specific zones, bosses,
# metrics, etc. This data is not considered frozen, and it can change without
# notice. Use at your own risk.
#
# Arguments
# byBracket: Optional. Whether or not to use bracket rankings
# instead of overall rankings. For WoW, brackets are item levels or keystones. For
# FF, brackets are patches.
# className: Optional. The slug for a specific class. Whether or
# not to filter rankings to a specific class. Only used by games that support
# multiple classes on a single character..
# compare: Optional. Whether or not to compare against rankings
# (best scores across the entire tier) or two weeks worth of parses (more
# representative of real-world performance).
# difficulty: Optional. Whether or not to filter the rankings to
# a specific difficulty. If omitted, the highest difficulty is used.
# includePrivateLogs: Optional. Whether or not to include private
# logs in the results. This option is only available if using the user GraphQL
# endpoint.
# metric: Optional. You can filter to a specific character metric
# like dps or hps. If omitted, an appropriate default metric for the zone will be
# chosen.
# partition: Optional. Whether or not to filter the rankings to a
# specific partition. By default, the latest partition is chosen. A special value
# of -1 can be passed to fetch data from all partitions.
# role: Optional. The slug for a specific role. This allow you to
# only fetch ranks for the healing role, dps role or tank role.
# size: Optional. Whether or not to filter rankings to a specific
# size. If omitted, the first valid raid size will be used.
# specName: Optional. The slug for a specific spec. Whether or
# not to filter rankings to a specific spec. If omitted, data for all specs will
# be used.
# timeframe: Optional. Whether or not the returned report
# rankings should be compared against today's rankings or historical rankings
# around the time the fight occurred.
# zoneID: Optional. If not specified, the latest unfrozen zone
# will be used.
zoneRankings(
byBracket: Boolean
className: String
compare: RankingCompareType
difficulty: Int
includePrivateLogs: Boolean
metric: CharacterRankingMetricType
partition: Int
role: RoleType
size: Int
specName: String
timeframe: RankingTimeframeType
zoneID: Int
): JSON
}
type CharacterData {
# Obtain a specific character either by id or by name/server_slug/server_region.
#
# Arguments
# id: Optional. The ID of a single character to retrieve.
# name: Optional. The name of a specific character. Must be used
# in conjunction with serverSlug and serverRegion to uniquely identify a
# character.
# serverSlug: Optional. The slug of a specific server. Must be
# used in conjunction with name and serverRegion to uniquely identify a character.
# serverRegion: Optional. The region for a specific character.
# Must be used in conjunction with name and serverRegion to uniquely identify a
# character.
character(
id: Int
name: String
serverSlug: String
serverRegion: String
): Character
# A collection of characters for a specific guild.
#
# Arguments
# guildID: Required. The ID of a specific guild. Characters from
# that guild will be fetched.
# limit: Optional. The number of characters to retrieve per page.
# If omitted, defaults to 100. The maximum allowed value is 100, and minimum
# allowed value is 1.
# page: Optional. The page of paginated data to retrieve. If
# omitted, defaults to the first page.
characters(guildID: Int, limit: Int, page: Int): CharacterPagination
}
type CharacterPagination {
# List of items on the current page
data: [Character]
# Number of total items selected by the query
total: Int!
# Number of items returned per page
per_page: Int!
# Current page of the cursor
current_page: Int!
# Number of the first item returned
from: Int
# Number of the last item returned
to: Int
# The last page (number of pages)
last_page: Int!
# Determines if cursor has more pages after the current page
has_more_pages: Boolean!
}
type Difficulty {
# An integer representing a specific difficulty level within a zone. For example,
# in World of Warcraft, this could be Mythic. In FF, it could be Savage, etc.
id: Int!
# The localized name for the difficulty level.
name: String!
# A list of supported sizes for the difficulty level. An empty result means that
# the difficulty level has a flexible raid size.
sizes: [Int]
}
type Encounter {
# The ID of the encounter.
id: Int!
# The localized name of the encounter.
name: String!
# Player rankings information for a zone. This data is not considered frozen, and
# it can change without notice. Use at your own risk.
#
# Arguments
# bracket: Optional. A specific bracket (e.g., item level range)
# to use instead of overall rankings. For WoW, brackets are item levels or
# keystones. For FF, brackets are patches.
# difficulty: Optional. A specific difficulty to fetch rankings
# for. If omitted, the highest difficulty is used.
# filter: Optional. A filter string for advanced searching. The
# syntax matches the one used on the web site exactly, so you can filter encounter
# rankings on the site to figure out the string to use.
# page: Optional. Which page of rankings to fetch. By default the
# first page is used.
# partition: Optional. Whether or not to filter the rankings to a
# specific partition. By default, the latest partition is chosen.
# serverRegion: Optional. The short name of a region to filter
# to. If paired with a server slug, will uniquely identify a server. If used by
# itself, rankings for that specific region will be fetched.
# serverSlug: Optional. The slug for a specific server. Whether
# or not to filter rankings to a specific server. If omitted, data for all servers
# will be used.
# size: Optional. Whether or not to filter rankings to a specific
# size. If omitted, the first valid raid size will be used.
# leaderboard: Optional. Controls whether to include ranks
# without backing logs in games & content types that support this. Ignored if
# unsupported.
# hardModeLevel: Optional. Filters ranks to a specific hard mode
# (0-5) or any hard mode level (-1). Most encounters do not have variable hard
# mode levels. Use `difficulty` for ESO Veteran Hard Modes.
# metric: Optional. You can filter to a specific player metric
# like dps or hps. If omitted, an appropriate default player metric for the zone
# will be chosen.
# includeCombatantInfo: Optional. Whether or not to include
# detailed combatant info such as gear in the results.
# className: Optional. The slug for a specific class. Whether or
# not to filter rankings to a specific class. If omitted, data for all classes
# will be used.
# specName: Optional. The slug for a specific spec. Whether or
# not to filter rankings to a specific spec. If omitted, data for all specs will
# be used.
# externalBuffs: Optional. Controls whether to include ranks
# with/without external buffs. Most games and zones do not support this filter and
# will quietly ignore it.
characterRankings(
bracket: Int
difficulty: Int
filter: String
page: Int
partition: Int
serverRegion: String
serverSlug: String
size: Int
leaderboard: LeaderboardRank
hardModeLevel: HardModeLevelRankFilter
metric: CharacterRankingMetricType
includeCombatantInfo: Boolean
className: String
specName: String
externalBuffs: ExternalBuffRankFilter
): JSON
# Fight rankings information for a zone. This data is not considered frozen, and
# it can change without notice. Use at your own risk.
#
# Arguments
# bracket: Optional. A specific bracket (e.g., item level range)
# to use instead of overall rankings. For WoW, brackets are item levels or
# keystones. For FF, brackets are patches.
# difficulty: Optional. A specific difficulty to fetch rankings
# for. If omitted, the highest difficulty is used.
# filter: Optional. A filter string for advanced searching. The
# syntax matches the one used on the web site exactly, so you can filter encounter
# rankings on the site to figure out the string to use.
# page: Optional. Which page of rankings to fetch. By default the
# first page is used.
# partition: Optional. Whether or not to filter the rankings to a
# specific partition. By default, the latest partition is chosen.
# serverRegion: Optional. The short name of a region to filter
# to. If paired with a server slug, will uniquely identify a server. If used by
# itself, rankings for that specific region will be fetched.
# serverSlug: Optional. The slug for a specific server. Whether
# or not to filter rankings to a specific server. If omitted, data for all servers
# will be used.
# size: Optional. Whether or not to filter rankings to a specific
# size. If omitted, the first valid raid size will be used.
# leaderboard: Optional. Controls whether to include ranks
# without backing logs in games & content types that support this. Ignored if
# unsupported.
# hardModeLevel: Optional. Filters ranks to a specific hard mode
# (0-5) or any hard mode level (-1). Most encounters do not have variable hard
# mode levels. Use `difficulty` for ESO Veteran Hard Modes.
# metric: Optional. You can filter to a specific fight metric
# like speed or execution. If omitted, an appropriate default fight metric for the
# zone will be chosen.
fightRankings(
bracket: Int
difficulty: Int
filter: String
page: Int
partition: Int
serverRegion: String
serverSlug: String
size: Int
leaderboard: LeaderboardRank
hardModeLevel: HardModeLevelRankFilter
metric: FightRankingMetricType
): JSON
# The zone that this encounter is found in.
zone: Zone!
}
type EncounterPhases {
encounterID: Int!
# Whether the phases can be used to separate wipes in the report UI.
separatesWipes: Boolean
# Phase metadata for all phases in this encounter.
phases: [PhaseMetadata!]
}
type Expansion {
# The ID of the expansion.
id: Int!
# The localized name of the expansion.
name: String!
# The zones (e.g., raids and dungeons) supported for this expansion.
zones: [Zone]
}
type GameAbility {
# The ID of the ability.
id: Int!
# The icon for the ability.
icon: String
# The localized name of the ability. Will be null if no localization information
# exists for the ability.
name: String
# A description for the ability if it is available.
description: String
}
type GameAbilityPagination {
# List of items on the current page
data: [GameAbility]
# Number of total items selected by the query
total: Int!
# Number of items returned per page
per_page: Int!
# Current page of the cursor
current_page: Int!
# Number of the first item returned
from: Int
# Number of the last item returned
to: Int
# The last page (number of pages)
last_page: Int!
# Determines if cursor has more pages after the current page
has_more_pages: Boolean!
}
type GameAchievement {
# The ID of the achievement.
id: Int!
# The icon for the achievement.
icon: String
# The localized name of the achievement. Will be null if no localization
# information exists for the achievement.
name: String
}
type GameAffix {
# The ID of the affix.
id: Int!
# The icon for the affix.
icon: String
# The localized name of the affix. Will be null if no localization information
# exists for the affix.
name: String
}
type GameClass {
# An integer used to identify the class.
id: Int!
# The localized name of the class.
name: String!
# A slug used to identify the class.
slug: String!
# The specs supported by the class.
specs: [GameSpec]
}