飞书开放平台 Server API 文档

主题

获取部门维度用户活跃及功能使用数据 ​

该接口用于获取部门维度的用户活跃和功能使用数据，即IM（即时通讯）、日历、云文档、音视频会议、邮箱功能的使用数据。

Warning: - 只有企业自建应用才有权限调用此接口

  • 当天的数据会在第二天的早上九点半产出（CN时区: UTC+8，非CN时区: UTC+0）

  • 数据权限范围配置：目前只支持给每个应用配置部门级别数据权限范围，默认包含子部门（应用数据权限在开放平台配置）

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/admin/v1/admin_dept_stats
HTTP MethodGET
接口频率限制特殊频控
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用admin:admin_dept_stat:readonly 获取部门维度的用户活跃和功能使用数据

请求头 ​

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

查询参数 ​

名称类型必填描述
department_id_typestring是部门ID类型
示例值：open_department_id
可选值有：
- department_id: 部门的 ID - open_department_id: 部门的 Open ID
start_datestring是起始日期（包含），格式是YYYY-mm-dd（CN UTC+8，非CN UTC+0）
示例值：2020-02-15
end_datestring是终止日期（包含），格式是YYYY-mm-dd，与起止日期start_date之间相差不能超过91天（包含91天）（CN UTC+8，非CN UTC+0）
示例值：2020-02-15
department_idstring是部门的 ID，取决于department_id_type，仅支持根部门及其下前4级子部门（通过管理后台部门详情获取）
示例值：od-382e2793cfc9471f892e8a672987654c
contains_child_deptboolean是是否包含子部门，如果该值为false，则只查出本部门直属用户活跃和功能使用数据；如果该值为true，则查出该部门以及其子部门（子部门层级最多不超过根部门下的前4级）的用户活跃和功能使用数据
示例值：false
page_sizeint否默认值是10，表示每页返回10条数据
示例值：10
数据校验规则：
- 取值范围：1 ～ 20
page_tokenstring否分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
示例值："2"
target_geostring否需跨域访问的Geo数据，每个Geo仅包含本Geo数据，不传默认查本地数据，调用前需要先开通FG(cn、sg、jp、us)
示例值：cn
with_product_versionboolean否是否返回分产品版本数据，默认false，不返回
示例值：true(默认是false)

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ has_moreboolean是否还有更多项
  └ page_tokenstring分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
  └ itemsadmin_dept_stat\[\]数据报表
    └ datestring日期
    └ department_idstring部门的department_id 或者open_department_id
    └ department_namestring部门名字
    └ department_pathstring部门路径
    └ total_user_numint部门总人数
    └ active_user_numint激活人数
    └ active_user_ratestring激活率
    └ suite_dauint活跃人数
    └ suite_active_ratestring活跃率
    └ new_user_numint新用户数
    └ new_active_numint新激活数
    └ resign_user_numint离职人数
    └ im_dauint消息活跃人数
    └ send_messenger_user_numint发送消息人数
    └ send_messenger_numint发送消息数
    └ avg_send_messenger_numstring人均发送消息数
    └ docs_dauint云文档活跃人数
    └ create_docs_user_numint创建文件人数
    └ create_docs_numint创建文件数
    └ avg_create_docs_numstring人均创建文件数
    └ cal_dauint日历活跃人数
    └ create_cal_user_numint创建日程人数
    └ create_cal_numint创建日程数
    └ avg_create_cal_numstring人均创建日程数
    └ vc_dauint音视频会议活跃人数
    └ vc_durationint会议时长：企业内员工参与通话与会议的总时长（分钟,不包括会议室的时长）
    └ avg_vc_durationstring人均会议时长（分钟，不包含会议室的时长）
    └ avg_durationstring人均飞书使用时长（分钟）
    └ task_dauint任务活跃人数
    └ create_task_user_numint创建任务人数
    └ create_task_numint创建任务数
    └ avg_create_task_numstring人均创建任务数
    └ email_send_countstring邮件总发件量
    └ email_receive_countstring邮件总收件量
    └ email_send_ext_countstring对外发件数
    └ email_receive_ext_countstring来自外部收件数
    └ email_send_in_countstring对内发件数
    └ email_receive_in_countstring来自内部收件数
    └ search_active_daustring大搜搜索活跃人数
    └ total_search_countstring总搜索次数（在飞书主端搜索框发起过搜索请求的会话数）
    └ quick_search_countstring综搜次数（在飞书主端搜索框的综合搜索发起过搜索请求的会话数）
    └ tab_search_countstring垂搜次数（在飞书主端搜索框的垂类搜索tab（例如消息tab、云文档tab）发起过搜索请求的会话数）
    └ product_versionstring产品版本名称

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "has_more": true,
        "page_token": "3",
        "items": [
            {
                "date": "2020-02-15",
                "department_id": "od-382e2793cfc9471f892e8a672987654c",
                "department_name": "subtestkkk",
                "department_path": "testkkk/subtestkkk",
                "total_user_num": 2,
                "active_user_num": 0,
                "active_user_rate": "1.00",
                "suite_dau": 0,
                "suite_active_rate": "0.00",
                "new_user_num": 0,
                "new_active_num": 0,
                "resign_user_num": 0,
                "im_dau": 0,
                "send_messenger_user_num": 0,
                "send_messenger_num": 0,
                "avg_send_messenger_num": "0.00",
                "docs_dau": 0,
                "create_docs_user_num": 0,
                "create_docs_num": 0,
                "avg_create_docs_num": "0.00",
                "cal_dau": 0,
                "create_cal_user_num": 0,
                "create_cal_num": 0,
                "avg_create_cal_num": "0.00",
                "vc_dau": 0,
                "vc_duration": 0,
                "avg_vc_duration": "0.00",
                "avg_duration": "0.00",
                "task_dau": 0,
                "create_task_user_num": 0,
                "create_task_num": 0,
                "avg_create_task_num": "0.00",
                "email_send_count": "2",
                "email_receive_count": "3",
                "email_send_ext_count": "4",
                "email_receive_ext_count": "5",
                "email_send_in_count": "6",
                "email_receive_in_count": "7",
                "search_active_dau": "7",
                "total_search_count": "7",
                "quick_search_count": "7",
                "tab_search_count": "7",
                "product_version": "全部产品版本"
            }
        ]
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
5001051001request contain invalid param请检查请求参数是否符合接口要求
4001051002application has no access to the resource请检查应用是否具备访问该资源的权限
4001051003There is no query permission for this department's data,please apply for permission for the application first应用数据权限范围不包含当前数据，需要在开放平台应用后台的「权限管理」->「开通权限」模块申请所需数据权限

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

本镜像仅供学习与查阅，文档版权归飞书所有