更新时间:2023-09-04 GMT+08:00
分享

查询用户统计趋势

功能介绍

查询用户不同接入类型、射频和SSID下的接入趋势图。

调用方法

GET

URL

/v1/ci/enaasclient/openapi/userstatistics/trend

表1 请求Query参数列表

名称

类型

是否必选

描述

param

String

查询参数,queryparam格式:

{

"regionType": "site",//区域类型。包含site(站点)、region(区域)、building(楼宇)和floor(楼层),必填项。

"level": "0",//左树级别。站点在左侧站点树的层级,对应0-9级,0为根,必填项。

"showType": "radio",//查询类型,包含radio(射频)、accType(接入类型)和ssid(SSID),必填项。

"startTime": "1598544000000",//开始时间,必填项。

"id": "/",//站点区域ID,“/”为根区域,必填项。

"endTime": "1598601596000",//结束时间,必填项。

"isAutoRefresh": "false",//接口是否自动刷新,包含false(否)和true(是),必填项。

}

最小长度:1

表2 请求Header参数列表

名称

类型

是否必选

描述

X-Auth-Token

String

认证Token,用于API的Token认证。

最小长度:0

最大长度:90000

请求Body参数

请求示例

GET /v1/ci/enaasclient/openapi/userstatistics/trend?param=null HTTP/1.1
Host: example.com
Content-Type: application/json
Accept: application/json
GET /rest/campusclientservice/v1/clientoverview/userstatistics/trend?param={
	"regionType":"site",
	"level":"0",
	"showType":"radio",
	"startTime":"1598544000000",
	"id":"/",
	"endTime":"1598601596000",
	"isAutoRefresh":"false"
} HTTP/1.1Content-Type: application/json;charset=UTF8Accept: application/jsonX-Auth-Token: MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgBZQMEAgEwggIOBgkqhkiG9w0BBwGgggH--jxxA==

响应参数

返回状态码为 200: 查询用户趋势成功。

表3 响应Body参数列表

名称

类型

是否必选

描述

resultCode

Integer

状态码。

缺省值:200

errorDes

String

错误描述。

缺省值:Successful.

errorReson

String

错误原因。

缺省值:Successful.

errorDetail

String

错误详情。

缺省值:Successful.

errorAdvice

String

错误建议。

缺省值:Successful.

data

Array of UserTrendModel

在线用户趋势数据模型。

表4 UserTrendModel

名称

类型

是否必选

描述

UserTrend

Array of HotTimeModel

热点时段返回模型。

表5 HotTimeModel

名称

类型

是否必选

描述

timestamp

Long

时间戳。

缺省值:0

usernum

Long

用户数。

缺省值:0

表6 返回状态码

返回状态码

状态码说明

响应参数

400

参数错误

401

该用户未认证

403

URL鉴权失败

404

REST接口没找到

500

服务器内部错误

502

网关错误

503

服务不可用

响应示例

HTTP/1.1 200 OK
Data:Tue,26 Jul 2022 17:31:54 GMT
Server: example.com
Content-Type: application/json
{
	    "data": {
		        "UserTrend": [
			            {
				                "timestamp": 1598903400000,
				                "usernum": 46            
			},
			            {
				                "timestamp": 1598904000000,
				                "usernum": 7            
			},
			            {
				                "timestamp": 1598904300000,
				                "usernum": 6            
			},
			            {
				                "timestamp": 1598904600000,
				                "usernum": 6            
			},
			            {
				                "timestamp": 1598904900000,
				                "usernum": 4            
			},
			            {
				                "timestamp": 1598905200000,
				                "usernum": 15            
			}        
		]    
	},
	    "resultCode": 0,
	    "errorDes": "Successful.",
	    "errorReson": "Success",
	    "errorDetail": "Successful.",
	    "errorAdvice": "Successful."
}

相关文档