ThingsKit物联网平台API文档-概览汇总

获取左侧底部信息

接口地址:/api/yt/homepage/left/bottom{?endTs,interval,startTs,trend}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
startTs统计时间区间开始时间，单位：毫秒querytrueinteger(int64)
endTs统计时间区间结束时间，单位：毫秒querytrueinteger(int64)
interval时间窗口，不能低于2小时。单位：毫秒querytrueinteger(int64)
trend统计数据类型，例如：租户趋势(TENANT_TREND)、客户趋势(CUSTOMER_TREND)、客户告警统计(CUSTOMER_ALARM_STATISTICAL)、客户消息统计(CUSTOMER_MESSAGE_STATISTICAL)querytruestring

响应参数:

参数名称参数说明类型
resultobject
setOrExpiredboolean

响应示例:

{
	"result": {},
	"setOrExpired": true
}

获取左侧顶部信息

接口地址:/api/yt/homepage/left/top

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

暂无

响应参数:

参数名称参数说明类型
alarmInfo告警统计BaseHomePageTop
sumCount总数integer(int32)
todayAdd今日新增integer(int32)
customerInfo客户统计BaseHomePageTop
sumCount总数integer(int32)
todayAdd今日新增integer(int32)
deviceInfo设备统计HomeDeviceInfoDTO
directConnection直连设备数量integer(int32)
gateWay网关设备数量integer(int32)
inActive未激活设备数量integer(int32)
offLine离线设备数量integer(int32)
onLine在线设备数量integer(int32)
sensor网关子设备数量integer(int32)
sumCount设备总数integer(int32)
todayAdd今日新增设备数量integer(int32)
messageInfo消息统计HomePageTopMessage
dataPointsCount数据点总数integer(int32)
messageCount消息总数integer(int32)
todayDataPointsAdd今日数据点新增integer(int32)
todayMessageAdd今日消息新增integer(int32)
productInfo产品统计BaseHomePageTop
sumCount总数integer(int32)
todayAdd今日新增integer(int32)
tenantInfo租户统计BaseHomePageTop
sumCount总数integer(int32)
todayAdd今日新增integer(int32)

响应示例:

{
	"alarmInfo": {
		"sumCount": 0,
		"todayAdd": 0
	},
	"customerInfo": {
		"sumCount": 0,
		"todayAdd": 0
	},
	"deviceInfo": {
		"directConnection": 0,
		"gateWay": 0,
		"inActive": 0,
		"offLine": 0,
		"onLine": 0,
		"sensor": 0,
		"sumCount": 0,
		"todayAdd": 0
	},
	"messageInfo": {
		"dataPointsCount": 0,
		"messageCount": 0,
		"todayDataPointsAdd": 0,
		"todayMessageAdd": 0
	},
	"productInfo": {
		"sumCount": 0,
		"todayAdd": 0
	},
	"tenantInfo": {
		"sumCount": 0,
		"todayAdd": 0
	}
}

获取右侧过期租户信息

接口地址:/api/yt/homepage/right/overdue{?page,pageSize}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明是否必须数据类型
pagepagetrueint
pageSizepageSizetrueint

响应参数:

参数名称参数说明类型
itemsarray
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态：启用/禁用boolean
icon租户图标string
idIDstring
name租户名称string
roleIds租户角色列表array
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string
totalinteger(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"roleIds": [],
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}

获取右侧Top10

接口地址:/api/yt/homepage/right/top10

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

暂无

响应参数:

参数名称参数说明类型
resultobject
setOrExpiredboolean

响应示例:

{
	"result": {},
	"setOrExpired": true
}

小程序APP首页统计信息

接口地址:/api/yt/homepage/app{?login}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
login只取告警数据querytrueboolean

响应参数:

参数名称参数说明类型
todayAlarm告警基础统计信息
activedAlarm未处理告警数量integer(int32)
clearedAck已处理告警数量integer(int32)
clearedUnack误报告警数量integer(int32)
total告警总数integer(int32)
todayCustomer客户基础统计信息
cancellation禁用或过期客户数量integer(int32)
loginUse活跃用户数integer(int32)
normal正常用户integer(int32)
total客户总数integer(int32)
todayDevice设备基础统计信息
inActive未激活设备数量integer(int32)
offLine离线设备数量integer(int32)
onLine在线设备数量integer(int32)
total设备总数integer(int32)
todayMsg流量基础统计信息
dataPoints数据点数量integer(int32)
message收发消息数量integer(int32)
todayTenant租户基础统计信息
expired过期租户数量integer(int32)
normal正常租户数量integer(int32)
total租户总数integer(int32)
totalAlarm告警统计告警基础统计信息
activedAlarm未处理告警数量integer(int32)
clearedAck已处理告警数量integer(int32)
clearedUnack误报告警数量integer(int32)
total告警总数integer(int32)
totalCustomer客户统计客户基础统计信息
cancellation禁用或过期客户数量integer(int32)
loginUse活跃用户数integer(int32)
normal正常用户integer(int32)
total客户总数integer(int32)
totalDevice设备统计设备基础统计信息
inActive未激活设备数量integer(int32)
offLine离线设备数量integer(int32)
onLine在线设备数量integer(int32)
total设备总数integer(int32)
totalMsg消息统计流量基础统计信息
dataPoints数据点数量integer(int32)
message收发消息数量integer(int32)
totalTenant租户统计租户基础统计信息
expired过期租户数量integer(int32)
normal正常租户数量integer(int32)
total租户总数integer(int32)

响应示例:

{
	"todayAlarm": {
		"activedAlarm": 0,
		"clearedAck": 0,
		"clearedUnack": 0,
		"total": 0
	},
	"todayCustomer": {
		"cancellation": 0,
		"loginUse": 0,
		"normal": 0,
		"total": 0
	},
	"todayDevice": {
		"inActive": 0,
		"offLine": 0,
		"onLine": 0,
		"total": 0
	},
	"todayMsg": {
		"dataPoints": 0,
		"message": 0
	},
	"todayTenant": {
		"expired": 0,
		"normal": 0,
		"total": 0
	},
	"totalAlarm": {
		"activedAlarm": 0,
		"clearedAck": 0,
		"clearedUnack": 0,
		"total": 0
	},
	"totalCustomer": {
		"cancellation": 0,
		"loginUse": 0,
		"normal": 0,
		"total": 0
	},
	"totalDevice": {
		"inActive": 0,
		"offLine": 0,
		"onLine": 0,
		"total": 0
	},
	"totalMsg": {
		"dataPoints": 0,
		"message": 0
	},
	"totalTenant": {
		"expired": 0,
		"normal": 0,
		"total": 0
	}
}
Tags:

Related Articles

2022年1月22日

云腾五洲科技2022年春节放假通知

2022年3月17日

团队就地解散！苹果汽车彻底“凉凉”了；华为最新全屋智能售价4万，简直比去年便宜太多；全球股市大反弹，抄底人赚翻？| 物联网头条

2022年3月19日

罗永浩拿上亿分手费？传交个朋友天价买账号；百度被裁员工爆料：团队曾超额完成业绩；华为自研编程语言可试用；中芯国际换帅 | 物联网头条