String scalar type represents textual data, represented as UTF-8
character sequences. The String type is most often used by GraphQL to
represent free-form human-readable text.
link GraphQL Schema definition
- scalar String
link Require by
- BracketA bracket description for a given raid zone. Brackets have a minimum value, maximum value, and a bucket that can be used to establish all of the possible brackets. The type field indicates what the brackets represent, e.g., item levels or game patches, etc.
- CharacterA player character. Characters can earn individual rankings and appear in reports.
- CharacterDataThe CharacterData object enables the retrieval of single characters or filtered collections of characters.
- DifficultyA single difficulty for a given raid zone. Difficulties have an integer value representing the actual difficulty, a localized name that describes the difficulty level, and a list of valid sizes for the difficulty level.
- EncounterA single encounter for the game.
- ExpansionA single expansion for the game.
- GameAbilityA single ability for the game.
- GameAchievementA single achievement for the game.
- GameAffixA single affix for Mythic Keystone dungeons.
- GameClassA single player class for the game.
- GameEnchantA single enchant for the game.
- GameFactionA faction that a player or guild can belong to. Factions have an integer id used to identify them throughout the API and a localized name describing the faction.
- GameItemA single item for the game.
- GameItemSetA single item set for the game.
- GameMapA single map for the game.
- GameNPCA single NPC for the game.
- GameSpecA spec for a given player class.
- GameZoneA single zone for the game.
- GuildA single guild. Guilds earn their own rankings and contain characters. They may correspond to a guild in-game or be a custom guild created just to hold reports and rankings.
- GuildAttendanceAttendance for a specific report within a guild.
- GuildDataThe GuildData object enables the retrieval of single guilds or filtered collections of guilds.
- GuildTagThe tag for a specific guild. Tags can be used to categorize reports within a guild. In the site UI, they are referred to as report tags.
- PartitionA single partition for a given raid zone. Partitions have an integer value representing the actual partition and a localized name that describes what the partition represents. Partitions contain their own rankings, statistics and all stars.
- PlayerAttendanceAttendance for a specific player on a specific raid night.
- ProgressRaceDataA way to obtain data for the top guilds involved in an ongoing world first or realm first progress race.
- RegionA single region for the game.
- ReportA single report uploaded by a player to a guild or personal logs.
- ReportAbilityThe ReportAbility represents a single ability that occurs in the report.
- ReportActorThe ReportActor represents a single player, pet or NPC that occurs in the report.
- ReportDataThe ReportData object enables the retrieval of single reports or filtered collections of reports.
- ReportDungeonPullThe ReportDungeonPull represents a single pull that occurs in a containing dungeon.
- ReportFightThe ReportFight represents a single fight that occurs in the report.
- ReportMasterDataThe ReporMastertData object contains information about the log version of a report, as well as the actors and abilities used in the report.
- ServerA single server. Servers correspond to actual game servers that characters and guilds reside on.
- SubregionA single subregion. Subregions are used to divide a region into sub-categories, such as French or German subregions of a Europe region.
- UserA single user of the site. Most fields can only be accessed when authenticated as that user with the "view-user-profile" scope.
- WorldDataThe world data object contains collections of data such as expansions, zones, encounters, regions, subregions, etc.
- ZoneA single zone from an expansion that represents a raid, dungeon, arena, etc.
- __DirectiveA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
- __EnumValueOne possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
- __FieldObject and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
- __InputValueArguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
- __TypeThe fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.