获取部门历史统计数据
适用版本>=v7.0.2412a.20241212
接口说明:获取部门历史统计数据
请求说明
| 请求地址 | 配置域名+/openapi+/v7/stats/dept/history_data |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 查询部门统计数据(应用授权) kso.dept_stats.read |
请求头(Header)
| Header | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| dept_id | string | 是 | 部门ID,仅支持根部门 |
| fields | string[] | 否 | 数据字段,不传则返回全部数据。 可选值: total_documents:文档总数;activated_members:成员激活数;active_users:活跃用户数;active_documents:活跃文档数;deleted_documents:删除文档数;downloaded_documents:下载文档数;new_documents:新增文档数;cloud_doc_active_users:云文档活跃人数; |
| date_type | string | 是 | 日期类型,仅支持day_range |
| start_date | string | 是 | 日期起始时间,yyyy-mm-dd 未传end_date时,仅查询start_date当日数据 |
| end_date | string | 否 | 日期截止时间,yyyy-mm-dd start_date与end_date的最大跨度为90天 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| detail | string | 详细信息 |
| msg | string | 状态信息 |
| data | object | 返回信息体 |
| ∟ items | object[] | |
| ∟ ∟ date | string | 日期,'yyyy-mm-dd' |
| ∟ ∟ activated_members | int | 成员激活数 |
| ∟ ∟ active_documents | int | 活跃文档数 |
| ∟ ∟ active_users | int | 活跃用户数 |
| ∟ ∟ cloud_doc_active_users | int | 云文档活跃人数 |
| ∟ ∟ deleted_documents | int | 删除文档数 |
| ∟ ∟ downloaded_documents | int | 下载文档数 |
| ∟ ∟ new_documents | int | 新增文档数 |
| ∟ ∟ total_documents | int | 文档总数 |
响应体示例
json
{
"data": {
"items": [
{
"date": "string",
"activated_members": 0,
"active_documents": 0,
"active_users": 0,
"cloud_doc_active_users": 0,
"deleted_documents": 0,
"downloaded_documents": 0,
"new_documents": 0,
"total_documents": 0
}
]
},
"code": 0,
"detail": "string",
"msg": "string"
}