| The Halo: Reach Stats API has been discontinued as of March 31st, 2012. The API is only serving historical data at this time. |
GetPlayerDetailsWithStatsByPlaylist
From Halo: Reach API Wiki
- This article is a stub. You can help improve the wiki by expanding it.
The "GetPlayerDetailsWithStatsByPlaylist" method Returns detailed aggregate information on a player, including arena information.
Contents |
[edit] Summary
[edit] Method
- GetPlayerDetailsWithStatsByPlaylist(System.String, System.String)
[edit] Parameters
- identifier
- Your application's unique identifier string (also known as your unique API key)
- gamertag
- The player's gamertag
[edit] Returns
- A PlayerDetailsResponse object that contains detailed aggregate statistics.
[edit] Example URL
http://www.bungie.net/api/reach/reachapijson.svc/player/details/byplaylist/{identifier}/{gamertag}
[edit] Detailed Response
| Field | Type | Description |
|---|---|---|
| status | integer | The integer value representing the error that occurred when trying to retrieve the file share for the player. |
| reason | string | The explanation of the error that occurred when trying to retrieve the file share for the player. |
| AiStatistics | See AiStatistics Table | An object containing detailed stats about the player seperated by playlist |
| CurrentRankIndex | string | Current Rank as number, value found in GlobalRanksById array. |
| CurrentSeasonArenaStatistics | null | This object is always null. |
| Player | See Player Table | A listing of all the basic stats for a single player. See Player Table. |
| PlayerModelUrl | string | URL to the player's spartan model. |
| PlayerModelUrlHiRes | string | URL to a hi-res version of the player's spartan model. |
| PriorSeasonArenaStatistics | null | This value is always null. |
| StatisticsByMap | null | This value is always null. |
| StatisticsByPlaylist | See AiStatistics Table | This object has the exact same structure of AiStatistics. See AiStatistics Table. |
[edit] Player
| Field | Type | Description |
|---|---|---|
| CampaignProgressCoop | string | The progress that the player has made in Co-op Campaign. Possible values include: None, PartialEasy, PartialNormal, PartialHeroic, PartialLegendary, CompletedEasy, CompletedNormal, CompletedHeroic, CompletedLegendary |
| CampaignProgressSp | string | The progress that the player has made in Single Player Campaign. Possible values include: None, PartialEasy, PartialNormal, PartialHeroic, PartialLegendary, CompletedEasy, CompletedNormal, CompletedHeroic, CompletedLegendary |
| initialized | boolean | Whether the Player object has been initialized (?) |
| IsGuest | boolean | Returns true is the player is a guest XBL account. Otherwise, false. |
| LastGameVariantClassPlayed | string | The last game variant played by the player. (See: Metadata for more information.) |
| ReachEmblem | object | Object representing the player's Reach emblem. More details on the Emblems page. |
| armor_completion_percentage | decimal | The percentage of the armory that the player has unlocked. |
| daily_challenges_completed | integer | The number of daily challenges that the player has completed. |
| first_active | date string | The date/time that the player first played Reach. |
| gamertag | string | The player's Gamertag |
| games_total | integer | The total number of games that the player has played. |
| last_active | date string | The date/time that the player last played Reach. |
| service_tag | string | The service tag for the player. |
| weekly_challenges_completed | integer | The number of weekly challenges that the player has completed. |
| CommendationState | array | List of the commendations, listed by key as returned by GetGameMetadata, along with the player's progress in each. |
| commendation_completion_percentage | decimal | The percentage of commendations that the player has completed. |
[edit] AiStatistics
The AiStatistics object contains Several objects all with the same parameters as below
| Field | Type | Description |
|---|---|---|
| DeathsByDamageType | array | List of the damage types, listed by key as returned by GetGameMetadata, along with the player's deaths by each. |
| DeathsByEnemyTypeClass | array | List of the enemy types, listed by key as returned by GetGameMetadata, along with the player's deaths by each. |
| HopperId | integer | Under AiStatistics, this is NULL. Under StatisticsByPlaylist, this is the playlist. |
| KillsByDamageType | array | List of the damage types, listed by key as returned by GetGameMetadata, along with the player's kills by each. |
| KillsByEnemyTypeClass | array | List of the enemy types, listed by key as returned by GetGameMetadata, along with the player's kills of each. |
| MapId | integer | The unique identifier for the Reach map that a map was built on, or an image/film clip were created on, as returned by GetGameMetaData. How does this number work for gametypes? |
| MedalChestCompletionPercent | decimal | The percentage of medals the player has completed in this playlist. |
| MedalCountsByType | array | List of the medal types, listed by key as returned by GetGameMetadata, along with the player's aggregate of each. |
| PointsByDamageType | array | List of the damage types, listed by key as returned by GetGameMetadata, along with the player's ?? by each. |
| PointsByEnemyTypeClass | array | List of the enemy types, listed by key as returned by GetGameMetadata, along with the player's ?? of each. |
| TotalMedals | integer | The aggregate of player medals in this playlist. |
| VariantClass | integer | The VariantClass of the game played. (See: Metadata for more information.) |
| biggest_kill_points | integer | An integer representing the largest points the player has received for a kill (?) |
| biggest_kill_streak | integer | An integer representing the most enemies the player has killed in one life (?) |
| game_count | integer | An integer representing the aggregate times the player has entered this playlist (?) |
| game_difficulty | array | An integer representing the highest game difficult played (?) |
| game_difficulty | array | An integer representing the highest game difficult played (?) |
| high_score | integer | (?) |
| high_score_coop | integer | (?) |
| high_score_solo | integer | (?) |
| highest_game_kills | integer | An integer representing the most kills a player has achieved in this playlist. |
| highest_set | integer | An integer representing the highest set a player has achieved. |
| highest_skull_multiplier | integer | An integer representing the highest multiplier from skulls a player has achieved in this playlist. |
| season_id | integer | An integer representing the season id (arena only). |
| total_assists | integer | An integer representing the aggregate assist the player has gained in this playlist. |
| total_betrayals | integer | An integer representing the aggregate betrayals the player has gained in this playlist. |
| total_deaths | integer | An integer representing the aggregate deaths the player has gained in this playlist. |
| total_enemy_players_killed | integer | An integer representing the aggregate enemies (human only (?)) the player has killed in this playlist. |
| total_first_place | integer | An integer representing the aggregate first place positions the player has achieved in this playlist. |
| total_generators_destroyed | integer | An integer representing the aggregate generators the player has destroyed in this playlist. |
| total_kills | integer | An integer representing the aggregate enemies (human and ai (?)) the player has killed in this playlist. |
| total_missions_beating_par | integer | An integer representing the aggregate missions the player has completed achieving par. |
| total_missions_not_dying | integer | An integer representing the aggregate missions the player has completed without dying. |
| total_playtime | string | A string representing the aggregate time the player has spent in this playlist. PHP usage example |
| total_score | integer | (?) |
| total_score_coop | integer | (?) |
| total_score_solo | integer | (?) |
| total_top_half_place | integer | An integer representing the aggregate times the player has been in the top 50 percent of a game in this playlist. |
| total_top_third_place | integer | An integer representing the aggregate times the player has been in the top 33 percent of a game in this playlist. |
| total_waves_completed | integer | An integer representing the aggregate waves the player has completed in this playlist. |
| total_wins | integer | An integer representing the aggregate wins the player has achieved in this playlist. |
[edit] Helpful Tips
- The AiStatistics object appears to be contain all VariantClasses including both individual (map per playlist) and combination (playlist) statistics.
- AiStatistics only includes game variants Campaign and Firefight. StatisticsByPlaylist only include game variants Competitive.
- If you are looking for your totals by a gametype, you will want the AiStatistics object where the
MapId=-1for your VariantClass (e.g. All Firefight stats would beVariantClass=5) - If you are looking for your totals by a specific playlist, you will want the StatisticsByPlaylist object where the HopperId is your playlist (e.g. Team Slayer is
102