统计服务

更新时间:2023-10-09 01:57:19下载pdf

API列表

API 描述
statistics.allType 获取设备支持的统计类型
statistics.total 获取历史累计数据
statistics.minutes 按分钟统计
statistics.hours 按小时统计
statistics.days 按天获取累计数据
statistics.weeks 按周获取累计数据
statistics.months 按月获取累计数据

获取设备支持的统计类型

功能描述:

查询具体的设备当前可支持的统计类型

接口地址:

action:  statistics.allType

完整调用此接口需进行产品配置。请使用产品的归属账号提交工单,工单内容请务必提供产品 ID 以及该产品 ID 下需要开通统计类功能的 DP ID(功能点 ID),我们将为您配置。

params请求参数

参数名 类型 说明 是否必填
device_id String 设备ID
code String 功能点 Code,根据产品而定 否,默认查询所有

请求示例

{
	"action": "statistics.allType",
	"params": {
		"device_id":"vdevo158331135285058"
	}
}

返回信息

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 对应dpCode 支持的统计类型

返回示例

{
    "success": true,
    "t": 1562898798074,
    "result": [
        {
            "code": "sum_dp",
            "stat_type": "sum"
        },
        {
            "code": "avg_dp",
            "stat_type": "avg"
        }
    ]
}

获取历史累计值

功能描述

获取历史累计值

接口地址

action:  statistics.total

params请求参数

参数名 类型 说明 是否必填
device_id String 设备ID
code String 功能点 Code,根据产品而定

请求示例

{
	"action": "statistics.total",
	"params": {
		"device_id":"vdevo158331135285058",
		"code":"electricity"
	}
}

返回信息

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result说明

参数名 类型 说明
total String 累计统计量

返回示例

{
    "success": true,
    "t": 1545286977957,
    "result": {
        "total" : "92.68"
    }
}

按分钟统计

功能描述:

查询具体的设备,最近7天的状态统计,返回当天中每隔15分钟的统计

接口地址:

action: statistics.quarters

params请求参数

参数名 类型 说明 是否必填
device_id String 设备ID
code String 功能点 Code,根据产品而定
start_quarter String 开始分钟,格式:yyyyMMddHHmm
end_quarter String 结束分钟,和start_minute同一天,且大于start_minute,格式:yyyyMMddHHmm

请求示例

{
	"action": "statistics.quarters",
	"params": {
		"device_id":"vdevo158331135285058",
		"code":"electricity",
		"start_quarter":"202003020815",
		"end_quarter":"202003021045"
	}
}

返回信息

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 操作成功标识

返回示例

{
    "success": true,
    "t": 1567079117639,
    "result": {
        "quarters": {
            "202003020815": "0.01",
            "202003020830": "0.00",
            "202003020845": "0.01",
            "202003020900": "0.00",
            "202003020915": "0.01",
            "202003020930": "0.00",
            "202003020945": "0.01",
            "202003021000": "0.00",
            "202003021015": "0.02",
            "202003021030": "0.00"
        }
    }
}

按小时统计

功能描述:

查询具体的设备,最近7天的状态统计,返回当天中每个小时的统计

接口地址:

action: statistics.hours

params请求参数

参数名 类型 说明 是否必填
device_id String 设备ID
code String 功能点 Code,根据产品而定
start_hour String 开始小时,格式:yyyyMMddHH
end_hour String 结束小时,和start_hour同一天,且大于start_hour,格式:yyyyMMddHH
stat_type String 统计类型默认sum,可选填count、avg

请求示例

{
	"action": "statistics.hours",
	"params": {
		"device_id":"vdevo158331135285058",
		"code":"electricity",
		"start_hour":"2020030100",
		"end_hour":"2020030123"
	}
}

返回信息:

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 操作成功标识

返回示例

{
    "success": true,
    "t": 1562747403791,
    "result": {
        "hours": {
            "2020030208": "0.00",
            "2020030209": "1.00",
            "2020030210": "1.00",
            "2020030211": "1.00",
            "2020030212": "1.00"
        }
    }
}

按天统计累计值

功能描述

按天统计累计值

接口地址

action: statistics.days

params请求参数

参数名 类型 说明 是否必填
device_id String 设备ID
code String 功能点 Code,根据产品而定
start_day String 开始的天,形如:20200225
end_day String 结束的天,形如:20200302
stat_type String 统计类型,选填,默认sum

请求示例

{
	"action": "statistics.days",
	"params": {
		"device_id":"vdevo158331135285058",
		"code":"electricity",
		"start_day":"20200225",
		"end_day":"20200302"
	}
}

返回信息

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result说明

参数名 类型 说明
days Map 每天的统计量

返回示例

{
    "success": true,
    "t": 1547650028453,
    "result": {
        "days": {
            "20200225": "0",
            "20200226": "0",
            "20200227": "0",
            "20200228": "0",
            "20200229": "0",
            "20200301": "0",
            "20200302": "0"
        }
    }
}

按星期统计累计值

功能描述

按星期统计累计值

接口地址

action: statistics.weeks

params请求参数

参数名 类型 说明 是否必填
device_id String 设备ID
code String 功能点 Code,根据产品而定
start_week String 开始周,数据格式:202005(2020年第5周)
end_week String 结束周,数据格式:202005(2020年第7周)

请求示例

{
	"action": "statistics.weeks",
	"params": {
		"device_id":"vdevo158331135285058",
		"code":"electricity",
		"start_week":"202005",
		"end_week":"202007"
	}
}

返回信息

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result说明

参数名 类型 说明
weeks Map 每星期的统计量

返回示例

{
    "success": true,
    "t": 1547650180271,
    "result": {
        "weeks": {
            "202005": "0",
            "202006": "0.02",
            "202007": "0"
        }
    }
}

按月统计累计值

功能描述

按月统计累计值

接口地址

action: statistics.months

params请求参数

参数名 类型 说明 是否必填
device_id String 设备ID
code String 功能点 Code,根据产品而定
start_month String 开始月份,形如:202001
end_month String 结束月份,形如:202003
  • 注: 开始月份和结束月份,不支持跨年

请求示例

{
	"action": "statistics.months",
	"params": {
		"device_id":"vdevo158331135285058",
		"code":"electricity",
		"start_month":"202001",
		"end_month":"202003"
	}
}

返回信息

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result说明

参数名 类型 说明
months Map 每月的统计量

返回示例

{
    "success": true,
    "t": 1545286977957,
    "result": {
        "months" : {
            "202001":"11.36",
            "202002":"13.81",
            "202003":"12.39",
        }
    }
}

获取目标功能点的统计结果累加值

功能描述

获取目标功能点的统计结果累加值

接口地址

action: statistics.all

params请求参数

参数名 类型 说明 是否必填
device_id String 设备ID
code String 功能点 Code,根据产品而定

请求示例

{
	"action": "statistics.all",
	"params": {
		"device_id":"vdevo158331135285058",
		"code":"electricity"
	}
}

返回信息

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result说明

参数名 类型 说明
this_day String 今日量
sum String 累计量
years Object 年度统计,按年月返回

返回示例

{
    "result": {
        "sum": "0.00",
        "thisDay": "0.0",
        "years": {
            "2020": {
                "03": "0.00"
            }
        }
    },
    "success": true,
    "t": 1583156170485
}