画布数据总览

更新时间 2025/02/22 07:19:43

英飞画布服务端支持基于 REST API 根据画布 recordId，获取该画布数据总览。数据涵盖画布内元素数量、画布内会议数量等统计信息。

前提条件

• 已经完成英飞画布应用的创建动作，详见新人指引文档。
• 了解 REST API 请求的认证方式，详见获取 Access Token 文档。
• 持有创建画布接口返回的画布 ID。

请求路径

https://developer.infi.cn/infi/api/v1/statistics/boardData

请求参数

字段

类型

描述

list

Array<string>

画布的 recordId 数组

请求 curl 示例

curl --location --request POST  \
      --header 'token: Access Token' \
      --header 'Content-Type: application/json' \
      --data '{
        "list": ["SAMPlE_RECORD_ID"]
      }'
      https://developer.infi.cn/infi/api/v1/statistics/boardData

请求成功情况

响应的 Http 状态码为 200 时表示请求成功，请求成功返回数据示例如下：

{
  "list": [
    {
      "recordId":"SAMPlE_RECORD_ID",
      "data": {
        "totalAccessView": 0,
        "totalUserView": 0,
        "totalMeeting": 0,
        "totalMeetingDuration": 0,
        "totalElement": 0,
        "totalNote": 0,
        "totalComment": 0,
        "totalText": 0,
        "totalFile": 0,
        "totalShape": 0,
        "totalPic": 0,
        "totalWeb": 0
      }
    }
  ]
}

成功返回的字段说明如下：

字段

类型

描述

recordId

string

画布ID

totalAccessView

integer

总访问次数

totalUserView

integer

总访问人数

totalMeeting

integer

总会议数

totalMeetingDuration

integer

总会议时长

totalElement

integer

总元素数量

totalNote

integer

便签数量

totalComment

integer

点评数量

totalText

integer

文本框数量

totalFile

integer

文件数

totalShape

integer

图形数

totalPic

integer

图片数

totalWeb

integer

网页数量

请求失败情况

响应的 Http 状态码不为 200 时表示请求失败，如需更多信息请参考请求错误说明文档。