获取排名板信息和用户数的API

Request


GET
url : https://gamepot.apigw.ntruss.com/gpapps/v2/leaderboard
Header 'x-api-key: 86dcgffae0xxxxxxxxxxxxxx'
Header : 'x-project-id: ec8231b2-6b20-4ad1-xxxx-xxxxxxxxx'

Header

Type

Required

Description

X-API-KEY

String

O

GamePot发放的认证密钥

X-PROJECT-ID

String

O

仪表盘项目ID

Attribute

Type

Required

Description

leaderboardId

String

O

在仪表盘中生成的排名板固有ID

offset

Integer

X

OFFSET

per_page

Integer

X

LIMIT

Response


成功

[
    {
        "status": true,
        "ranking": "best",
        "tie_breaking": "first",
        "id": "TGVhZGVyYm9hcmQ6YXNkYWRhZHNhZHNh",
        "name": "test",
        "description": "TEST",
        "descending": true,
        "resetDay": 0,
        "resetTime": "00:00",
        "resetDate": 1,
        "startedAt": "2023-01-25T12:09:47-08:00",
        "timezone": "America/Kralendijk",
        "project_id": "ec8231b2-6b20-4ad1-9c59-8e183087a742",
        "period_type": "monthly",
        "icon_url": "sdadasds",
        "user_count": 28,
    }
]
  

Attribute

Type

Required

Description

id

String

O

排名板固有ID

projectId

String

O

项目ID

status

Boolean

O

状态

is_check_user

Boolean

-

是否检查用户ID

name

String

-

排名板名称

description

String

-

说明

icon_url

String

-

图标URL

descending

Boolean

-

排序

startedAt

String

-

开始日期

expiredAt

String

-

结束日期(season的情况)

timezone

String

-

时区

period_type

String

-

周期(daily、weekly、monthly、season)

resetDay

Integer

-

初始化日期 1:星期日、2.星期一、3.星期二、4.星期三、5.星期四、6.星期五、7.星期六(periodType为weekly时)

resetTime

String

-

初始化时间

resetDate

Integer

-

初始化日期1~31(periodType为monthly时)

ranking

String

O

排名更新标准(latest、accumulated、best)

tie_breaking

String

O

同分者处理标准(first、last)

失败

{
    "status": -1,
    "message": "错误消息"
}

Attribute

Type

Description

status

Int

结果值(失败时请参考Error code)

message

String

错误内容

Last updated