阅读列表 - 歌者 Open API

请求参数

Path 参数

docId

string

文档 ID

必需

示例值:

文档 ID

Query 参数

_startIndex

string

可选

翻页参数，开始序号，从 0 开始

示例值:

开始序号

_maxResults

string

返回结果数

可选

示例值:

返回结果数

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'http://prod-cn.your-api-server.com/docs/ 文档 ID/visits?_startIndex=开始序号&_maxResults=返回结果数'

返回响应

🟢200成功

application/json

Body

array of:

docId

string

文档 ID

可选

id

string

唯一序号

可选

spaceId

null

空间 ID

可选

docViewerId

string

浏览者 ID

可选

startAt

string

浏览开始时间

可选

endAt

string

浏览结束时间

可选

lastActiveAt

string

最近一次活动时间

可选

duration

integer

持续时间

可选

pageDurations

string

浏览持续时间

可选

pageNum

integer

浏览页数

可选

percent

integer

百分比

可选

country

string

国家

可选

province

string

省份

可选

city

string

城市

可选

downloaded

string

是否下载

可选

liked

string

是否点赞

可选

paid

string

是否支付

可选

messaged

string

是否填写表单

可选

saved

string

是否保存文件

可选

client

string

客户端类型

可选

createdAt

string

记录创建时间

可选

updatedAt

string

更新时间

可选

viewer

object

必需

id

string

用户 ID

必需

avatar

string

头像地址

必需

name

string

昵称

必需

province

string

省份

必需

city

string

城市

必需

gender

string

性别

必需

uniqueId

string

唯一 ID

必需

userAgent

object

可选

id

string

必需

isMobile

string

是否移动端

必需

browserName

string

浏览器

必需

language

string

语言

必需

app

string

APP

必需

browserVersion

string

浏览器版本

必需

osName

string

OS 名称

必需

osVersion

string

OS 版本

必需

deviceModel

string

设备机型

必需

deviceType

string

设备类型

必需

示例

[
  {
    "docId": "string",
    "id": "string",
    "spaceId": null,
    "docViewerId": "string",
    "startAt": "string",
    "endAt": "string",
    "lastActiveAt": "string",
    "duration": 0,
    "pageDurations": "string",
    "pageNum": 0,
    "percent": 0,
    "country": "string",
    "province": "string",
    "city": "string",
    "downloaded": "string",
    "liked": "string",
    "paid": "string",
    "messaged": "string",
    "saved": "string",
    "client": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "viewer": {
      "id": "string",
      "avatar": "string",
      "name": "string",
      "province": "string",
      "city": "string",
      "gender": "string",
      "uniqueId": "string"
    },
    "userAgent": {
      "id": "string",
      "isMobile": "string",
      "browserName": "string",
      "language": "string",
      "app": "string",
      "browserVersion": "string",
      "osName": "string",
      "osVersion": "string",
      "deviceModel": "string",
      "deviceType": "string"
    }
  }
]