Data reporting

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.

WARNING You have to request dedicated SERVER ACCESS TOKEN that is meant only for your servers and must not be included in you game clients

POST/v1/dataReportGetTournaments

List all tournaments

Query finished tournaments from specific date range.

Required attributes

  • Name
    accessToken
    Type
    String
    Description

    value has to be SERVER ACCESS TOKEN

  • Name
    sinceDate
    Type
    UTC Date-time
    Description

    value has to be UTC date and time in format 2022-10-29T00:00:00 (inclusive)

  • Name
    untilDate
    Type
    UTC Date-time
    Description

    value has to be UTC date and time in format (inclusive)

Request

POST
/v1/dataReportGetTournaments
curl -G https://backbone-client-api.azurewebsites.net/api/v1/dataReportGetTournaments \
  -H "BACKBONE_APP_ID: 123456789" \
  -H "Accept-Encoding: gzip" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d accessToken=382481156290 \
  -d sinceDate=2022-10-29T00:00:00 \
  -d untilDate=2022-10-29T00:00:00

Example response

  • Name
    tournamentId
    Type
    64 bit number as string
    Description
  • Name
    templateId
    Type
    64 bit number as sString
    Description
  • Name
    createdAt
    Type
    UTC Date-time
    Description

    Date and time when tournament was created

  • Name
    name
    Type
    String
    Description

    Default name of the tournament

  • Name
    type
    Type
    Type
    Description

    Type of the tournament

    • 0 - public
    • 1 - premium
    • 2 - private
    • 3 - testing
  • Name
    startedAt
    Type
    date-time
    Description

    Date and time of the tournament start

  • Name
    finishedAt
    Type
    date-time
    Description

    UTC datetime of tournament end in format 2022-10-30T04:15:49.420Z (inclusive)

  • Name
    signedUpCount
    Type
    integer
    Description

    User sign-up count (excludes players who fail to form a team)

  • Name
    maxSignedUpCount
    Type
    integer
    Description

    Maximum number of users

  • Name
    partySize
    Type
    integer
    Description

    Required size of team/party

  • Name
    phaseCount
    Type
    integer
    Description

    Count of tournament phases

  • Name
    roundCount
    Type
    integer
    Description

    Count of all tournament rounds across all phases

Example response

{
  "tournamentId": "63809769643125123",		
  "templateId": "63009307313241234",
  "createdAt": "2022-10-27T19:32:26.063Z",
  "name": "NameOfTheTournament 2v2",
  "type": 1,
  "startedAt": "2022-10-29T23:00:00.000Z",
  "finishedAt": "2022-10-30T04:15:49.420Z",
  "signedUpCount": 24563,
  "maxSignedUpCount": 30000,
  "partySize": 1,
  "phaseCount": 4,
  "roundCount": 34
}
POST/v1/dataReportGetTournamentUsers

Tournament participants

Query participants of specific tournament.

Required attributes

  • Name
    accessToken
    Type
    String
    Description

    value has to be SERVER ACCESS TOKEN

  • Name
    tournamentId
    Type
    64 bit number as string
    Description

    value has to be ID of specific tournament

Request

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

Example response

  • Name
    createdAt
    Type
    UTC Date-time
    Description

    UTC datetime when user was added (ticket created)

  • Name
    tournamentId
    Type
    64 bit number as string
    Description
  • Name
    ticketId
    Type
    64 bit number as string
    Description
  • Name
    userId
    Type
    64 bit number as string
    Description
  • Name
    userExternalId
    Type
    String
    Description

    External system ID as string

  • Name
    partyId
    Type
    64 bit number as string
    Description
  • Name
    status
    Type
    Integer
    Description

    Status of user's ticket

    • 0 - invited
    • 1 - confirmed (can play)
    • 2 - declined
    • 3 - incomplete party
    • 4 - processing signup
    • 5 - signup fail
    • 6 - processing signout
    • 7 - signout fail
  • Name
    checkIn
    Type
    Boolean
    Description

    Flag indicating user's attendance

  • Name
    userPlace
    Type
    Integer
    Description

    User's final placement

  • Name
    totalPlayTime
    Type
    Integer
    Description

    User's total playtime (in minutes)

  • Name
    matchCount
    Type
    Integer
    Description

    User's total match count

  • Name
    gameCount
    Type
    Integer
    Description

    User's total game count

  • Name
    maxPhase
    Type
    Integer
    Description

    User's reached phase (>=1)

Example response

[
  {
    "createdAt": "2022-10-25T15:00:35.447Z",
    "tournamentId": "63592122754314523",
    "ticketId": "63730450823452345234",
    "userId": "410158954303241234",
    "userExternalId": "XXXXXX",
    "partyId": "6373045088123412432",
    "status": 1,
    "checkIn": false,
    "userPlace": 0,
    "totalPlayTime": null,
    "matchCount": null,
    "gameCount": null,
    "maxPhase": null
  }
]
POST/v1/dataReportGetTournamentTemplates

Tournament template stats

Query daily performance stats of templates from specific date range.

Required attributes

  • Name
    accessToken
    Type
    String
    Description

    value has to be SERVER ACCESS TOKEN

  • Name
    sinceDate
    Type
    UTC Date-time
    Description

    value has to be UTC date and time in format 2022-10-29T00:00:00 (inclusive)

  • Name
    untilDate
    Type
    UTC Date-time
    Description

    value has to be UTC date and time in format 2022-10-30T00:00:00 (inclusive)

Request

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

Example response

  • Name
    recordedAt
    Type
    UTC Date-time
    Description

    UTC datetime of day stats account for

  • Name
    templateId
    Type
    64 bit number as string
    Description
  • Name
    name
    Type
    String
    Description

    Name of tournament template

  • Name
    type
    Type
    Type
    Description

    Type of the tournament

    • 0 - public
    • 1 - premium
    • 2 - private
    • 3 - testing
  • Name
    tournamentCount
    Type
    Integer
    Description

    Count of tournaments for a day

  • Name
    dtaAvg
    Type
    Double
    Description

    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.

  • Name
    dtaSum
    Type
    Integer
    Description

    Sum of checked in users who played all template tournaments this day.

  • Name
    dtaUSum
    Type
    Integer
    Description

    Sum of unique checked in users who played all template tournament this day.

  • Name
    mtaAvg
    Type
    Double
    Description

    Monthly tournament attendance. Same as daily stat above but aggregated over past 30 days.

  • Name
    mtaSum
    Type
    Integer
    Description

    Same as daily stat above but aggregated over past 30 days.

  • Name
    mtaUSum
    Type
    Integer
    Description

    Same as daily stat above but aggregated over past 30 days.

  • Name
    wtr1
    Type
    Integer
    Description

    Weekly retention over past month (week 1)

  • Name
    wtr2
    Type
    Integer
    Description

    Weekly retention over past month (week 2)

  • Name
    wtr3
    Type
    Integer
    Description

    Weekly retention over past month (week 3)

  • Name
    wtr4
    Type
    Integer
    Description

    Weekly retention over past month (week 4)

Example response

[
  {
    "recordedAt": "2022-10-26T00:00:00.000Z",
    "templateId": "60208317421341234",
    "name": "Battlecup",
    "type": 2,
    "tournamentCount": 1,
    "dtaAvg": 88.89,
    "dtaSum": 8,
    "dtaUSum": 8,
    "mtaAvg": 79.46,
    "mtaSum": 465,
    "mtaUSum": 47,
    "wtr1": 47,
    "wtr2": 31,
    "wtr3": 16,
    "wtr4": 14
  }
]