播放统计

⚠️ 该部分尚未设计完成

Anniv 提供基本的播放统计功能。

播放记录

Endpoint

POST /api/stat

请求

请求参数

请求参数类型为 SongPlayRecord[] 。

参数表示

interface SongPlayRecord {
  track: TrackIdentifier;
  // 播放开始的时间
  at: number[];
}

客户端设计指引

当用户播放时间过短（如少于 10 秒，少于全曲的 1/3 等，具体由播放器决定）时，不应该汇报本次播放。

获取当前用户播放记录

Endpoint

GET /api/stat/self

请求

请求参数

参数名详情
from统计区间开始时间戳（秒）
to统计区间结束时间戳（秒），默认为请求提交时间

返回

返回 SongPlayRecordResult[] ，按播放次数降序排序。

参数表示

interface SongPlayRecordResult {
  track: TrackIdentifier;
  count: number;
}

获取歌曲的播放统计

Endpoint

GET /api/stat/song

请求

请求参数

参数名详情
album_id请求歌曲所属专辑的 album_id
disc_id请求歌曲的 disc_id
track_id请求歌曲的 track_id

返回

若请求成功，返回对应曲目的播放统计。

返回参数

参数名类型详情
countnumber请求曲目的播放次数

获取当前用户播放历史记录

Endpoint

GET /api/stat/self/history

请求

请求参数

参数名详情
limit返回条目数量上限，默认为 10
offset返回条目的偏移量，默认为 0

返回

返回 HistoryRecord[] ，按播放时间降序排序。

参数表示

interface HistoryRecord {
  track: TrackIdentifier;
  at: number;
}

获取当前用户单曲播放次数

Endpoint

GET /api/stat/self/song

请求

请求参数

参数名详情
album_id请求歌曲所属专辑的 album_id
disc_id请求歌曲的 disc_id
track_id请求歌曲的 track_id
from统计区间开始时间戳（秒），默认为 0
to统计区间结束时间戳（秒），默认为请求提交时间

返回

若请求成功，返回对应曲目的播放次数。

返回参数

参数名类型详情
countnumber请求曲目的播放次数