歌者 Open API

文档阅读者列表

开发中

GET

/docs/{docId}/viewers

指定文档阅读者的信息，一个用户阅读多次，只记录一次

请求参数

Path 参数

docId

string

文档 ID

必需

Query 参数

_startIndex

string

可选

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

示例值:

开始序号

_maxResults

string

返回结果数

可选

示例值:

返回结果数

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

返回响应

🟢200成功

application/json

Body

array of:

string

记录 ID

可选

spaceId

string

空间 ID

可选

docId

string

文档 ID

可选

viewerId

string

浏览者 ID

可选

visitNum

number

访问次数

必需

downloadNum

number

下载次数

可选

favoriteAt

null

收藏时间

可选

totalDuration

number

总阅读持续时间

可选

lastVisitedAt

string

上次访问时间

可选

mobile

null

手机号

可选

null

邮箱

可选

likedAt

string

点赞时间

可选

点赞时间

sharedNum

number

分享次数

可选

orderNo

string

订单 ID

可选

订单 ID（如果有）

payedAt

null

支付时间

可选

支付时间（如果有）

payedAmount

null

支付金额

可选

支付金额（如果有）

deviceIds

null

设备 ID

可选

createdAt

string

记录创建时间

可选

updatedAt

string

最近更新时间

可选

viewer

object

可选

string

阅读者 ID

必需

avatar

string

头像地址

必需

name

string

昵称

必需

platform

string

平台

必需

示例

[
    {
        "id": "string",
        "spaceId": "string",
        "docId": "string",
        "viewerId": "string",
        "visitNum": 0,
        "downloadNum": 0,
        "favoriteAt": null,
        "totalDuration": 0,
        "lastVisitedAt": "string",
        "mobile": null,
        "email": null,
        "likedAt": "string",
        "sharedNum": 0,
        "orderNo": "string",
        "payedAt": null,
        "payedAmount": null,
        "deviceIds": null,
        "createdAt": "string",
        "updatedAt": "string",
        "viewer": {
            "id": "string",
            "avatar": "string",
            "name": "string",
            "platform": "string"
        }
    }
]

演示文稿合并

阅读列表