-
-
Notifications
You must be signed in to change notification settings - Fork 66
/
api_admin_admin_user_stats_get.go
121 lines (110 loc) · 9.62 KB
/
api_admin_admin_user_stats_get.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// Code generated by lark_sdk_gen. DO NOT EDIT.
/**
* Copyright 2022 chyroc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package lark
import (
"context"
)
// GetAdminUserStats 用于获取用户维度的用户活跃和功能使用数据, 即IM（即时通讯）、日历、云文档、音视频会议、邮箱功能的使用数据。
//
// - 只有企业自建应用才有权限调用此接口
// - 当天的数据会在第二天的早上九点半产出（UTC+8）
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/admin-v1/admin_user_stat/list
// new doc: https://open.feishu.cn/document/server-docs/admin-v1/data-report-management/list-2
func (r *AdminService) GetAdminUserStats(ctx context.Context, request *GetAdminUserStatsReq, options ...MethodOptionFunc) (*GetAdminUserStatsResp, *Response, error) {
if r.cli.mock.mockAdminGetAdminUserStats != nil {
r.cli.Log(ctx, LogLevelDebug, "[lark] Admin#GetAdminUserStats mock enable")
return r.cli.mock.mockAdminGetAdminUserStats(ctx, request, options...)
}
req := &RawRequestReq{
Scope: "Admin",
API: "GetAdminUserStats",
Method: "GET",
URL: r.cli.openBaseURL + "/open-apis/admin/v1/admin_user_stats",
Body: request,
MethodOption: newMethodOption(options),
NeedTenantAccessToken: true,
}
resp := new(getAdminUserStatsResp)
response, err := r.cli.RawRequest(ctx, req, resp)
return resp.Data, response, err
}
// MockAdminGetAdminUserStats mock AdminGetAdminUserStats method
func (r *Mock) MockAdminGetAdminUserStats(f func(ctx context.Context, request *GetAdminUserStatsReq, options ...MethodOptionFunc) (*GetAdminUserStatsResp, *Response, error)) {
r.mockAdminGetAdminUserStats = f
}
// UnMockAdminGetAdminUserStats un-mock AdminGetAdminUserStats method
func (r *Mock) UnMockAdminGetAdminUserStats() {
r.mockAdminGetAdminUserStats = nil
}
// GetAdminUserStatsReq ...
type GetAdminUserStatsReq struct {
UserIDType *IDType `query:"user_id_type" json:"-"` // 用户 ID 类型, 示例值: open_id, 可选值有: open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多: 如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid), union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的, 在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID, 应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多: 如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id), user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内, 一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多: 如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id), 默认值: `open_id`, 当值为 `user_id`, 字段权限要求: 获取用户 user ID
DepartmentIDType *DepartmentIDType `query:"department_id_type" json:"-"` // 部门ID类型, 示例值: open_department_id, 可选值有: department_id: 部门的 ID, open_department_id: 部门的 Open ID
StartDate string `query:"start_date" json:"-"` // 起始日期（包含）, 格式是YYYY-mm-dd, 示例值: 2020-02-15
EndDate string `query:"end_date" json:"-"` // 终止日期（包含）, 格式是YYYY-mm-dd。起止日期之间相差不能超过31天（包含31天）, 示例值: 2020-02-15
DepartmentID *string `query:"department_id" json:"-"` // 部门的 ID, 取决于department_id_type, 示例值: od-382e2793cfc9471f892e8a672987654c
UserID *string `query:"user_id" json:"-"` // 用户的open_id, user_id或者union_id, 取决于user_id_type, 示例值: ou_7dab8a3d3cdcc9da365777c7ad535d62
PageSize *int64 `query:"page_size" json:"-"` // 分页大小, 示例值: 10, 取值范围: `1` ～ `60`
PageToken *string `query:"page_token" json:"-"` // 分页标记, 第一次请求不填, 表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token, 下次遍历可采用该 page_token 获取查询结果, 示例值: 2
TargetGeo *string `query:"target_geo" json:"-"` // 需跨域访问的Geo数据, 每个Geo仅包含本Geo数据, 不传默认查本地数据, 调用前需要先开通FG（cn、us、sg、jp）, 每次只能查一个Geo数据, 示例值: cn
}
// GetAdminUserStatsResp ...
type GetAdminUserStatsResp struct {
HasMore bool `json:"has_more,omitempty"` // 是否还有更多项
PageToken string `json:"page_token,omitempty"` // 分页标记, 当 has_more 为 true 时, 会同时返回新的 page_token, 否则不返回 page_token
Items []*GetAdminUserStatsRespItem `json:"items,omitempty"` // 数据报表
}
// GetAdminUserStatsRespItem ...
type GetAdminUserStatsRespItem struct {
Date string `json:"date,omitempty"` // 日期
UserID string `json:"user_id,omitempty"` // 用户ID
UserName string `json:"user_name,omitempty"` // 用户名
DepartmentName string `json:"department_name,omitempty"` // 部门名
DepartmentPath string `json:"department_path,omitempty"` // 部门路径
CreateTime string `json:"create_time,omitempty"` // 账号创建时间
UserActiveFlag int64 `json:"user_active_flag,omitempty"` // 用户激活状态, 可选值有: 0: 未激活, 1: 已激活
RegisterTime string `json:"register_time,omitempty"` // 激活时间
SuiteActiveFlag int64 `json:"suite_active_flag,omitempty"` // 用户活跃状态, 用户在飞书套件任意应用登陆, 即为活跃。包括飞书即时消息, 文档, 日历, 会议, 开放平台等, 可选值有: 0: 无活跃, 1: 活跃
LastActiveTime string `json:"last_active_time,omitempty"` // 最近活跃时间
IMActiveFlag int64 `json:"im_active_flag,omitempty"` // 用户消息活跃状态, 发生过如下事件, 则认为该用户消息活跃: 发送消息、回复消息、reaction、转发消息、阅读消息、查看会话、发送表情消息等, 可选值有: 0: 无活跃, 1: 活跃
SendMessengerNum int64 `json:"send_messenger_num,omitempty"` // 发送消息数
DocsActiveFlag int64 `json:"docs_active_flag,omitempty"` // 用户云文档活跃状态, "发生过如下事件, 则认为该用户云文档活跃: 事件1: 文档/文件打开, 事件2: 进入docs相关页面: 如文档详情页, space的各个页面", 可选值有: 0: 无活跃, 1: 活跃
CreateDocsNum int64 `json:"create_docs_num,omitempty"` // 创建文件数
CalActiveFlag int64 `json:"cal_active_flag,omitempty"` // 用户日历活跃状态, 发生过如下事件, 则认为用户日历活跃, 包含进入日历、创建日程、收到日程邀请等, 可选值有: 0: 无活跃, 1: 活跃
CreateCalNum int64 `json:"create_cal_num,omitempty"` // 创建日程数
VCActiveFlag int64 `json:"vc_active_flag,omitempty"` // 用户音视频会议活跃状态, 用户进入会中状态（不包含妙记和直播）即为活跃, 可选值有: 0: 无活跃, 1: 活跃
VCDuration int64 `json:"vc_duration,omitempty"` // 会议时长（分钟）
ActiveOs string `json:"active_os,omitempty"` // 活跃设备
CreateTaskNum int64 `json:"create_task_num,omitempty"` // 创建任务数
VCNum int64 `json:"vc_num,omitempty"` // 会议数
AppPackageType string `json:"app_package_type,omitempty"` // 飞书的应用类型名称
OsName string `json:"os_name,omitempty"` // 操作系统名称
EmailSendCount string `json:"email_send_count,omitempty"` // 邮件总发件量
EmailReceiveCount string `json:"email_receive_count,omitempty"` // 邮件总收件量
EmailSendExtCount string `json:"email_send_ext_count,omitempty"` // 对外发件数
EmailReceiveExtCount string `json:"email_receive_ext_count,omitempty"` // 来自外部收件数
EmailSendInCount string `json:"email_send_in_count,omitempty"` // 对内发件数
EmailReceiveInCount string `json:"email_receive_in_count,omitempty"` // 来自内部收件数
}
// getAdminUserStatsResp ...
type getAdminUserStatsResp struct {
Code int64 `json:"code,omitempty"` // 错误码, 非 0 表示失败
Msg string `json:"msg,omitempty"` // 错误描述
Data *GetAdminUserStatsResp `json:"data,omitempty"`
Error *ErrorDetail `json:"error,omitempty"`
}