获取部门维度的用户活跃和功能使用数据

该接口用于获取部门维度的用户活跃和功能使用数据，即IM（即时通讯）、日历、云文档、音视频会议功能的使用数据。
只有企业自建应用才有权限调用此接口

当天的数据会在第二天的早上九点半产出（UTC+8）

错误码

HTTP状态码	错误码	描述	排查建议
500	1051001	request contain invalid param	请求中包含非法参数
400	1051002	request to exceed authority	请求发生越权

curl --location --request GET 'https://open.feishu.cn/open-apis/admin/v1/admin_dept_stats?department_id_type=&start_date=&end_date=&department_id=&contains_child_dept=&page_size=&page_token=' \ --header 'Authorization;'

{ "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" } ] } }

请求参数

Query 参数

department_id_type

string

必需

部门ID类型

示例值："open_department_id"

可选值有：

department_id：部门的 ID
open_department_id：部门的 Open ID

start_date

string

必需

起始日期（包含），格式是YYYY-mm-dd

示例值："2020-02-15"

end_date

string

必需

终止日期（包含），格式是YYYY-mm-dd，起止日期之间相差不能超过91天（包含91天）

示例值："2020-02-15"

department_id

string

必需

部门的 ID，取决于department_id_type，仅支持根部门及其下前4级子部门

示例值："od-382e2793cfc9471f892e8a672987654c"

contains_child_dept

string

必需

是否包含子部门，如果该值为false，则只查出本部门直属用户活跃和功能使用数据；如果该值为true，则查出该部门以及其子部门（子部门层级最多不超过根部门下的前4级）的用户活跃和功能使用数据

示例值：false

page_size

string

可选

分页大小，默认是10

示例值：10

数据校验规则：

取值范围：1 ～ 20

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；当返回的has_more为true时，会返回新的page_token，再次调用接口，传入这个page_token，将获得下一页数据

示例值："2"

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

has_more

boolean

必需

分页查询时返回，代表是否还有更多数据

page_token

string

必需

分页标记，下一页分页的token

items

array [object {32}]

数据报表

必需

获取部门维度的用户活跃和功能使用数据

错误码#

请求参数

返回响应

错误码