Source

This page was generated with Wiki Builder. Do not change the format!

Info

Gets aggregated stats for a clan using the same categories as the clan leaderboards. PREVIEW: This endpoint is still in beta, and may experience rough edges. The schema is in final form, but there may be bugs that prevent desirable operation.

Parameters

Path Parameters

Name Schema Required Description
groupId integer:int64 Yes Group ID of the clan whose leaderboards you wish to fetch.

Query String Parameters

Name Schema Required Description
modes string No List of game modes for which to get leaderboards. See the documentation for DestinyActivityModeType for valid values, and pass in string representation, comma delimited.

Example

Request

GET https://www.bungie.net/Platform/Destiny2/Stats/AggregateClanStats/{groupId}/

Response

PlatformErrorCode: 200

{
    // Type: DestinyClanAggregateStat[]
    "Response": [
       // Type: DestinyClanAggregateStat
        {
            // Type: DestinyActivityModeType:Enum
            "mode": {},
            // Type: string
            "statId": "",
            // Type: DestinyHistoricalStatsValue
            "value": {}
        }
    ],
    // Type: PlatformErrorCodes:Enum
    "ErrorCode": 0,
    // Type: integer:int32
    "ThrottleSeconds": 0,
    // Type: string
    "ErrorStatus": "",
    // Type: string
    "Message": "",
    // Type: Dictionary<string,string>
    "MessageData": {
        "{string}": ""
    },
    // Type: object
}

References

  1. https://bungie-net.github.io/multi/operation_get_Destiny2-GetClanAggregateStats.html#operation_get_Destiny2-GetClanAggregateStats