Data reporting
Available in the Gaming Circle and Industries Circle
Query tournament data reports
You can query past tournament data for custom analytics.
The HTTP calls are POST and the format has to be application/x-www-form-urlencoded
.
You have to request dedicated SERVER ACCESS TOKEN that is meant only for your servers
and must not be included in you game clients
Tournaments
Query finished tournaments from specific date range.
Endpoint URL:
https://backbone-client-api.azurewebsites.net/api/v1/dataReportGetTournaments
Headers:
BACKBONE_APP_ID: YOUR-TSDK-GAME-CLIENT-ID
Accept-Encoding: gzip
Content-Type: application/x-www-form-urlencoded
application/x-www-form-urlencoded parameters:
accessToken
sinceDate
untilDate
accessToken
value has to be SERVER ACCESS TOKENsinceDate
value has to be UTC date and time in format 2022-10-29T00:00:00 (inclusive)untilDate
value has to be UTC date and time in format 2022-10-30T00:00:00 (inclusive)
Response:
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
}
]
Tournament participants
Query participants of specific tournament.
Endpoint URL:
https://backbone-client-api.azurewebsites.net/api/v1/dataReportGetTournamentUsers
Headers:
BACKBONE_APP_ID: YOUR-TSDK-GAME-CLIENT-ID
Accept-Encoding: gzip
Content-Type: application/x-www-form-urlencoded
application/x-www-form-urlencoded parameters:
accessToken
tournamentId
accessToken
value has to be SERVER ACCESS TOKENtournamentId
value has to be ID of specific tournament
Response:
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
}
]
Tournament template stats
Query daily performance stats of templates from specific date range.
Endpoint URL:
https://backbone-client-api.azurewebsites.net/api/v1/dataReportGetTournamentTemplates
Headers:
BACKBONE_APP_ID: YOUR-TSDK-GAME-CLIENT-ID
Accept-Encoding: gzip
Content-Type: application/x-www-form-urlencoded
application/x-www-form-urlencoded parameters:
accessToken
sinceDate
untilDate
accessToken
value has to be SERVER ACCESS TOKENsinceDate
value has to be UTC date and time in format 2022-10-29T00:00:00 (inclusive)untilDate
value has to be UTC date and time in format 2022-10-30T00:00:00 (inclusive)
Response:
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
}
]