文章 List Leaderboard REST 端点

URLs

GET api/v1/leaderboards.xml (or .json)

请求参数

名称

类型

描述

必需

默认值

选项

ContainerId

Guid?

Filter by Container to list group level leaderboards. Optional. If ContainerId is set, Scope is ignored and automatically set to 'Container'.

Scope

string

Filter by leaderboard location. Optional. Possible values are (All, Global, Container). Ignored if ContainerId is specified.

Status

string

Filter by leaderboard active/inactive status. Optional. Possible values are (All, Active, Future, Expired).

ContentIds

string

Comma separated list of ContentIds. Used to limit to a specific set of leaderboards as well as sort order if SoryBy is set to ContentIdsOrder.

SortOrder

string

Accepted values are: Ascending, Descending

SortBy

string

Accepted values are: Name (default), CreatedDate, ContentIdsOrder

PageSize

int

Number of results to return

PageIndex

int

Page of results to return