Skip to content

获取妙记统计数据

通过这个接口,可以获得妙记的访问情况统计,包含PV、UV、访问过的 user id、访问过的 user timestamp。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/minutes/v1/minutes/:minute_token/statistics
HTTP MethodGET
接口频率限制5 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可minutes:minutes 查看、创建、编辑及管理妙记文件 minutes:minutes.statistics:read 获取妙记的统计信息 minutes:minutes:readonly 查看妙记文件
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
minute_tokenstring妙记唯一标识。可从妙记的 URL 链接中获取,一般为最后一串字符:https://sample.feishu.cn/minutes/==obcnq3b9jl72l83w4f14xxxx==
示例值:"obcnq3b9jl72l83w4f14xxxx"
数据校验规则
- 长度范围:2424 字符

查询参数

名称类型必填描述
user_id_typestring用户 ID 类型
示例值:open_id
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ statisticsstatictics妙记浏览信息统计
    └ user_view_countstring用户浏览数
    └ page_view_countstring页面浏览数量
    └ user_view_listuser_view_detail\[\]用户浏览列表
      └ user_idstring用户ID
      └ view_timestring用户的最近查看时间timestamp(ms级别)

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "statistics": {
            "user_view_count": "3",
            "page_view_count": "20",
            "user_view_list": [
                {
                    "user_id": "ou_612b787ccd3259fb3c816b3f678dxxxx",
                    "view_time": "1669121332000"
                }
            ]
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
4002091001param is invalid检查参数是否正确
4042091002resource not found无法找到对应妙记,检查Token是否正确
4002091003minute not ready , try later检查妙记是否转写完成
4002091004resource deleted检查妙记是否已被删除
4032091005permission deny检查是否有该篇妙记的阅读权限

内容来源:飞书开放平台 · 自动爬取整理