This document is about: QUANTUM 2
SWITCH TO

Data reporting


Available in the Gaming Circle and Industries Circle
Circle

查詢錦標賽資料報告

您可以查詢過去的錦標賽資料以進行自訂分析。

HTTP調用是POST,並且格式必須是application/x-www-form-urlencoded

您必須請求僅適用於您的伺服器的專用的伺服器存取權杖 並且其不得被包含在您的遊戲客戶端中

錦標賽

查詢在特定日期範圍內的已完成的錦標賽。

端點URL:

https://backbone-client-api.azurewebsites.net/api/v1/dataReportGetTournaments

標頭:

BACKBONE_APP_ID: YOUR-TSDK-GAME-CLIENT-ID
Accept-Encoding: gzip
Content-Type: application/x-www-form-urlencoded

application/x-www-form-urlencoded參數:

accessToken
sinceDate
untilDate
  • accessToken值必須是伺服器存取權杖
  • sinceDate值必須是UTC日期及時間,格式為2022-10-29T00:00:00(內含)
  • untilDate值必須是UTC日期及時間,格式為2022-10-30T00:00:00(內含)

回應:

JavaScript

[
    {
        // 64 bit number as string
        "tournamentId": "63809769643125123",
        // 64 bit number as string
        "templateId": "63009307313241234",
        // UTC datetime when tournament was created
        "createdAt": "2022-10-27T19:32:26.063Z",
        // Default name of the tournament
        "name": "NameOfTheTournament 2v2",
        // Type of the tournament
        // 0 - public
        // 1 - premium
        // 2 - private
        // 3 - testing
        "type": 1,
        // UTC datetime of tournament start
        "startedAt": "2022-10-29T23:00:00.000Z",
        // UTC datetime of tournament end
        "finishedAt": "2022-10-30T04:15:49.420Z",
        // User sign up count
        // NOTE: excludes players who fail to form a team
        "signedUpCount": 24563,
        // Maximum number of users
        "maxSignedUpCount": 30000,
        // Required size of team/party
        "partySize": 1,
        // Count of tournament phases
        "phaseCount": 4,
        // Count of all tournament rounds across all phases
        "roundCount": 34
    }
]

錦標賽參與者

查詢特定錦標賽的參與者。

端點URL:

https://backbone-client-api.azurewebsites.net/api/v1/dataReportGetTournamentUsers

標頭:

BACKBONE_APP_ID: YOUR-TSDK-GAME-CLIENT-ID
Accept-Encoding: gzip
Content-Type: application/x-www-form-urlencoded

application/x-www-form-urlencoded參數:

accessToken
tournamentId
  • accessToken值必須是伺服器存取權杖
  • tournamentId值必須是特定錦標賽的ID

回應:

JavaScript

[
    {
        // UTC datetime when user was added (ticket created)
        "createdAt": "2022-10-25T15:00:35.447Z",
        // 64 bit number as string
        "tournamentId": "63592122754314523",
        // 64 bit number as string
        "ticketId": "63730450823452345234",
        // 64 bit number as string
        "userId": "410158954303241234",
        // External system ID as string
        "userExternalId": "XXXXXX",
        // Playfab ID as string
        "userPlayfabId": "XXXXXX",
        // 64 bit number as string
        "partyId": "6373045088123412432",
        // Status of user's ticket
        // 0 - invited
        // 1 - confirmed (can play)
        // 2 - declined
        // 3 - incomplete party
        // 4 - processing signup
        // 5 - signup fail
        // 6 - processign signout
        // 7 - signout fail
        "status": 1,
        // Flag indicating user's attendance
        "checkIn": false,
        // User's final placement
        "userPlace": 0,
        // User's total playtime (in minutes)
        "totalPlayTime": null,
        // User's total match count
        "matchCount": null,
        // User's total game count
        "gameCount": null,
        // User's reached phase (>=1)
        "maxPhase": null
    }
]

錦標賽範本統計資料

查詢特定日期範圍內的範本的每日性能統計資料。

端點URL:

https://backbone-client-api.azurewebsites.net/api/v1/dataReportGetTournamentTemplates

標頭:

BACKBONE_APP_ID: YOUR-TSDK-GAME-CLIENT-ID
Accept-Encoding: gzip
Content-Type: application/x-www-form-urlencoded

application/x-www-form-urlencoded參數:

accessToken
sinceDate
untilDate
  • accessToken值必須是伺服器存取權杖
  • sinceDate值必須是UTC日期及時間,格式為2022-10-29T00:00:00(內含)
  • untilDate值必須是UTC日期及時間,格式為2022-10-30T00:00:00(內含)

回應:

JavaScript

[
    {
        // UTC datetime of day stats account for
        "recordedAt": "2022-10-26T00:00:00.000Z",
        // 64 bit number as string
        "templateId": "60208317421341234",
        // Name of tournament template
        "name": "Battlecup",
        // Type of the tournament
        // 0 - public
        // 1 - premium
        // 2 - private
        // 3 - testing
        "type": 2,
        // Count of tournaments for a day
        "tournamentCount": 1,
        // Daily tournament attendance.
        // Average percentage of users who checked in and played the tournament.
        // Example 100 successful signups, 75 users played would result in 75% attendance.
        "dtaAvg": 88.89,
        // Sum of checked in users who played all template tournaments this day.
        "dtaSum": 8,
        // Sum of unique checked in users who played all template tournament this day.
        "dtaUSum": 8,
        // Monthly tournament attendance.
        // Same as daily stat above but aggregated over past 30 days.
        "mtaAvg": 79.46,
        // Same as daily stat above but aggregated over past 30 days.
        "mtaSum": 465,
        // Same as daily stat above but aggregated over past 30 days.
        "mtaUSum": 47,
        // Weekly retention over past month (week 1)
        "wtr1": 47,
        // Weekly retention over past month (week 2)
        "wtr2": 31,
        // Weekly retention over past month (week 3)
        "wtr3": 16,
        // Weekly retention over past month (week 4)
        "wtr4": 14
    }
]
Back to top