TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixBitsLeaderboardQuery

Filters for the bits leaderboard request.

{
The user ID to show.
contextUserId?: string
The number of leaderboard entries you want to get.
count?: number
The time period from which bits should count towards the leaderboard.
period?:
HelixBitsLeaderboardPeriod

The possible time periods for a bits leaderboard.

Aliased type: "day" | "week" | "month" | "year" | "all"

The time to get the bits leaderboard for.
startDate?: Date
}

Properties

contextUserId

Type: ?string

The user ID to show.

The leaderboard will be guaranteed to include this user and then have more users before and after that user.

count

Type: ?number

The number of leaderboard entries you want to get.

period

Type:
HelixBitsLeaderboardPeriod

The possible time periods for a bits leaderboard.

Aliased type: "day" | "week" | "month" | "year" | "all"

The time period from which bits should count towards the leaderboard.

The leaderboards reset with the start of a new period, e.g. the week leaderboards reset every Monday midnight PST.

startDate

Type: ?Date

The time to get the bits leaderboard for.