获取应用使用概览
POST
/application/v6/applications/{app_id}/app_usage/overview
1.
2.
3.
4.
5.
6.
错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 403 | 211004 | no authority for quota limit | 检查是否是企业版/旗舰版租户 |
| 400 | 211005 | invalid app id | 检查 app id |
| 400 | 211006 | invalid department id | 检查 department id |
| 400 | 211007 | invalid date format | 检查 date 字段的格式是否符合"2021-07-01" |
| 400 | 211008 | invalid ability | 检查 ability 取值是否正确 |
| 400 | 211009 | invalid cycle type | 检查 cycle_type 取值是否正确 |
| 400 | 211010 | invalid date range | 检查 date 的取值范围是否正确 |
| 200 | 211011 | data not found | 数据不存在。正常情况：该应用在目标日期没有数据 |
附录-统计指标说明
| 指标 | 指标定义 | 备注 |
|---|---|---|
| 小程序应用活跃用户数 | 打开小程序的唯一用户数，按用户ID去重 | 支持查看某一天/某一周/某一个月的数据 |
| 网页应用活跃用户数 | 打开网页应用的唯一用户数，按用户ID去重只统计飞书内webview容器部分的数据，不包含三方浏览器容器的内容 | 支持查看某一天/某一周/某一个月的数据 |
| 机器人应用活跃用户数 | 满足以下条件之一就算作机器人的活跃用户：机器人消息已读主动给机器人发消息单个统计周期内按照用户ID合并去重； | 支持查看某一天/某一周/某一个月的数据 |
| 应用活跃用户数 | 满足以下条件之一就算作应用的活跃用户：打开小程序打开h5给机器人发消息阅读机器人消息单个统计时间周期内按 用户ID去重计数，以上所有条件合并去重 | 支持查看某一天/某一周/某一个月的数据 |
| 应用累计用户数 | 历史上所有使用过应用的用户数 | 由于累计用户数与时间周期无关，所以只支持截止到某一天的累计用户数即cycle_type只能为1只支持查看应用粒度的累计用户数，不支持区分小程序网页和机器人。即 ability 只能为 app注：累计用户数会包含离职人员的统计，所以可能会出现累计用户数大于租户成员数的情况 |
| 应用新增用户数 | 统计周期内首次访问的唯一用户数 | 支持查看某一天/某一周/某一个月的数据只支持查看应用粒度的累计用户数，不支持区分小程序网页和机器人。即 ability 只能为 app |
| 应用打开次数 | 在飞书客户端内打开应用（小程序或网页）的次数 | 当ability为app、h5、mp时返回具体数据，当ability为bot时返回为空。注：当用户主动退出应用或切换至其他应用超 5min 后记为一次打开 |
| 页面访问数 | 在应用（小程序或网页）中访问的页面次数 | 当ability为app、h5、mp时返回具体数据，当ability为bot时返回为空。注：若应用使用过程中切换到其他应用，再切换回飞书打开此应用时，pv会增加 |
请求参数
Path 参数
Query 参数
Body 参数application/json
返回响应
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/application/v6/applications/cli_9f115af860f7901b/app_usage/overview?department_id_type=open_department_id' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"date": "2021-07-26",
"cycle_type": 1,
"department_id": "od-bb009b4df5431400dc31d3bc8a37e069",
"ability": "app"
}'响应示例响应示例
{
"code": 0,
"data": {
"items": [
{
"metric_name": "uv",
"metric_value": 0
},
{
"metric_name": "total_users",
"metric_value": 2
},
{
"metric_name": "new_users",
"metric_value": 0
},
{
"metric_name": "pv",
"metric_value": 0
},
{
"metric_name": "lifecycle",
"metric_value": 0
}
]
},
"msg": "success"
}
扫码加入交流群修改于 2025-10-21 07:48:35