文档首页/ 华为云会议 Meeting/ 服务端API参考/ 仪表盘/ 会议统计/ 接口参考/ 查询企业级会议的用户统计数据
更新时间：2024-10-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询企业级会议的用户统计数据

描述

该接口用于查询企业内用户数据统计：

  • 查询会议用户登录数据，按日/按月统计。
  • 查询会议用户激活数据，按日/按月统计。
  • 查询会议用户登录设备数据，按日/按月统计。

仅旗舰版企业的企业管理员有权限查询。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/metrics/dashboard/statistic/user/info

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

offset

否

Integer

Query

查询偏移量。

  • 取值：大于等于0，默认值为0
  • 若offset大于等于最大条目数量，则返回最后一页数据，页数根据总条目数和limit计算得出

limit

否

Integer

Query

查询的条目数量。

  • 取值：1-500，默认值为20

timeUnit

是

String

Query

查询时间维度，取值：

  • D: 按日查询
  • M: 按月查询

startTime

是

String

Query
查询时间范围的开始时间，格式根据timeUnit的取值而定。
  • timeUnit = D，格式：yyyy-MM-dd，此情况下startTime与endTime间隔最多31日
  • timeUnit = M，格式：yyyy-MM，此情况下startTime与endTime间隔最多12个月

endTime

是

String

Query
查询时间范围的结束时间，格式根据timeUnit的取值而定。
  • timeUnit = D，格式：yyyy-MM-dd，此情况下startTime与endTime间隔最多31日
  • timeUnit = M，格式：yyyy-MM，此情况下startTime与endTime间隔最多12个月

category

是

String

Query

查询分类，取值：

  • user_login_info: 用户登录数据
  • user_activate_info: 用户激活数据
  • user_login_device_info: 用户登录设备数据

X-Access-Token

是

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

状态码

表3 状态码说明

HTTP状态码

描述

400

Bad Request 客户端传参异常。

401

Unauthorized 未鉴权或鉴权失败。

403

Forbidden 权限受限。

500

服务端异常。

响应参数

表4 响应参数

参数

类型

描述

count

Integer

总记录数。

limit

Integer

查询条目数量。

offset

Integer

查询偏移量。

data

Array of StatisticUserDataItem objects

会议用户数据按时间点统计的查询结果数组。
表5 StatisticUserDataItem数据结构

参数名称

参数类型

描述

time

String

日期/月份。

userLoginCount

String

登录用户数。

category = user_login_info时有效。

userPCLoginCount

String

PC端登录用户数。

category = user_login_info时有效。

userMobileLoginCount

String

移动端登录用户数。

category = user_login_info时有效。

userActivatedCount

String

激活用户数。

category = user_activate_info时有效。

userLoginDevicesName

String

用户登录设备名称。

category = user_login_device_info时有效。

userLoginDevicesCount

String

用户登录设备数。

category = user_login_device_info时有效。

请求消息示例

GET /v1/metrics/dashboard/statistic/user/info?timeUnit=D&startTime=2021-03-19&endTime=2021-03-20&category=user_login_device_info&offset=0&limit=10
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应消息示例

HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 2450
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c
Server: api-gateway
X-Request-Id: ac9f75ec3c97c823f128526a924532b2
{
	"count": 4,
	"limit": 10,
	"offset": 0,
	"data": [{
			"time": "2021-03-19",
			"userLoginDevicesName": "安卓",
			"userLoginDevicesCount": "177"
		},
		{
			"time": "2021-03-20",
			"userLoginDevicesName": "Windows",
			"userLoginDevicesCount": "178"
		},
		{
			"time": "2021-03-20",
			"userLoginDevicesName": "ios",
			"userLoginDevicesCount": "178"
		},
		{
			"time": "2021-03-20",
			"userLoginDevicesName": "安卓",
			"userLoginDevicesCount": "178"
		}
	]
}

错误码

当您使用华为云会议服务端API时，如果遇到“MBI”开头的错误码，请参考华为云API错误中心。

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -s "https://api.meeting.huaweicloud.com/v1/metrics/dashboard/statistic/user/info?timeUnit=D&startTime=2021-03-19&endTime=2021-03-20&category=user_login_device_info&offset=0&limit=10"
父主题： 接口参考

相关文档