OBJECT

Character

A player character. Characters can earn individual rankings and appear in reports.

link GraphQL Schema definition

  • type Character {
  • # 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!
  • # 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
  • # The faction of the character.
  • faction: GameFaction!
  • # 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 level of the character.
  • level: Int!
  • # The name of the character.
  • name: String!
  • # 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
  • }