Create Leaderboard REST 端点

Name

string

Name of the Leaderboard

是

NumberOfLeaders

int

Number of Users to show on the Leaderboard

是

Description

string

Description of the Leaderboard

否

ApplicationKey

string

Application Key for url

否

ContainerId

Guid?

Filter points to those earned within a certain Container. Optional.

否

StartDate

DateTime

Specify the earliest date scores will count for this leaderboard. Either StartDate + EndDate, or TimeSpanValue + TimeSpanType are required.

否

EndDate

DateTime

Specify the earliest date scores will count for this leaderboard. Either StartDate + EndDate, or TimeSpanValue + TimeSpanType are required.

否

StartDisplayDate

DateTime

Only show the leaderboard on the site after this date. Optional, defaults to StartDate.

否

EndDisplayDate

DateTime

Only show the leaderboard on the site before this date. Optional, defaults to EndDate

否

TimeSpanValue

int

Specify the number of (days/months/years), based on the TimeSpanType. Either StartDate + EndDate, or TimeSpanValue + TimeSpanType are required.

否

TimeSpanType

string

Specify the time of time span for calculations (days/months/years). Either StartDate + EndDate, or TimeSpanValue + TimeSpanType are required. Options are: Day, Month, Year.

否

PeriodType

string

Specify the anchor for the time span rolling window. Past (default) = generalized timespan counting backwards from current time or EndDate. Current = timespan starting from the beginning of the specified month/day/year. Options are: AllTime, Static, Rolling.

否

IncludeRolesFilter

string

Comma separated list of Site RoleIds. Used to limit the leaders for the leaderboard. Only users assigned the provided site roles will be eligable to be on the leaderboard.

否

ExcludeRolesFilter

string

Comma separated list of Site RoleIds. Used to limit the leaders for the leaderboard. Only users who are not assigned the provided site roles will be eligable to be on the leaderboard.

否