API 参考读取 API

可用周期目录

先看哪些周 / 月有数据,再逐期取排行。

GET/api/v1/rankings/periods
GET
/api/v1/rankings/periods

先列目录、再逐期取排行,就不必猜哪些期存在。两种读法用同一组参数覆盖:

  • 给了 year:返回该年有数据的期,升序;
  • 不给 year:倒序返回最近若干期(默认 120)。

只列有数据的期——列出一个没有行的周,等于把客户端送去拿一个必然 404 的请求。

Authorization

bearerAuth
AuthorizationBearer <token>

Authorization: Bearer <key>。key 由控制台自助签发,或管理员在 /dashboard 代签

In: header

Query Parameters

year?integer

四位年份。给了就按该年升序返回;不给则倒序返回最近若干期

cadence?string

周期类型

Default"weekly"

Value in

  • "weekly"
  • "monthly"
limit?integer

返回条数上限,缺省 120

Range1 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/rankings/periods"
{  "cadence": "weekly",  "periods": [    {      "year": 0,      "week": 0    }  ]}