巡店设备热点

获取区域统计

接口描述:

接口地址: https://yd.yunding360.com/openapi/hotspot/area_count

请求方式：POST

请求示例：

{
    "channel": 0,
    "deviceId": "",
    "dateType":"hour",
    "startTime": 0,
    "endTime": 0,
    "orderColumn": "",
    "orderDirection": "",
    "storeId": ""
}

请求参数：

参数名称 参数说明 in 是否必须 数据类型 schema
page 页数(从0开始计数,默认为0) query true integer
size 每页数量(默认20) query true integer
theQuery theQuery body true 热点区域内统计结果查询参数 热点区域内统计结果查询参数

schema属性说明

热点区域内统计结果查询参数

参数名称 参数说明 in 是否必须 数据类型 schema
channel 设备通道号 body false integer(int32)
deviceId 门店设备id body false string(uuid)
dateType 查询时间类型 body false string hour(小时),day(天),week(周),month(月),默认为day
startTime 开始时间 body false integer(int64)
endTime 结束时间 body false integer(int64)
orderColumn 排序字段,可用值: numberOfTotal, durationAvg, amount, trade body false string
orderDirection 排序顺序,可用值: NONE, ASC, DESC body false string
storeId 门店id，以“,”分割字符串 body false string

响应示例:

{
    "durationAvg": 0,
    "numberOfTotal": 0,
    "pageData": {
        "content": [
            {
                "areaId": "",
                "channel": 0,
                "channelName": "",
                "deviceId": "",
                "durationAvg": 0,
                "durationCount": 0,
                "numberOfGt": 0,
                "numberOfLte": 0,
                "numberOfTotal": 0,
                "storeId": "",
                "time": 0
            }
        ],
        "metadata": {
            "page": 0,
            "size": 0,
            "totalElements": 0,
            "totalPages": 0
        }
    }
}

响应参数:

参数名称 参数说明 类型 schema
durationAvg 平均停留时长 number(double) number(double)
numberOfTotal 总停留人次 integer(int64) integer(int64)
pageData 热点区域列表分页数据 PagedHotspotAreaAggregationInfo PagedHotspotAreaAggregationInfo

schema属性说明

PagedHotspotAreaAggregationInfo

参数名称 参数说明 类型 schema
content array HotspotAreaAggregationDoc
metadata 分页信息 PageMetadata PageMetadata

HotspotAreaAggregationDoc

参数名称 参数说明 类型 schema
areaId 区域ID string(uuid)
channel 设备通道号 integer(int32)
channelName 设备通道名称 string
deviceId 设备ID string(uuid)
durationAvg 平均停留时长(s) integer(int64)
durationCount 总停留时长 integer(int64)
numberOfGt 大于分段值的人次 integer(int64)
numberOfLte 小于等于分段值的人次 integer(int64)
numberOfTotal 总停留人次 integer(int64)
storeId 门店ID string(uuid)
time 时间 integer(int64)

PageMetadata

参数名称 参数说明 类型 schema
page 页数 integer(int64)
size 每页数量 integer(int64)
totalElements 总数 integer(int64)
totalPages 总页数 integer(int64)

响应状态:

状态码 说明 schema
200 OK HotspotAreaSummaryInfo

获取热点流向（动向）统计结果

接口描述:

接口地址: https://yd.yunding360.com/openapi/hotspot/flow_direction/count

请求方式：POST

请求示例：

{
    "channel": 0,
    "dateType": "",
    "deviceIds": [],
    "endTime": 0,
    "startTime": 0,
    "storeIds": []
}

请求参数：

参数名称 参数说明 in 是否必须 数据类型 schema
query query body true 热点流向（动线）数据查询参数 热点流向（动线）数据查询参数

schema属性说明

热点动线数据查询参数

参数名称 参数说明 in 是否必须 数据类型 schema
channel 设备通道号 body false integer(int32)
dateType 查询时间类型,默认 DAY,可用值: HOUR, DAY, WEEK, MONTH, QUARTER, YEAR body false string
deviceIds 门店设备id body false array
endTime 结束时间, 每日时间结束为 23:59:59 的时间戳 body false integer(int64)
startTime 开始时间, 每日时间结束为 0:00:00 的时间戳 body false integer(int64)
storeIds 门店id body false array

响应示例:

[
    {
        "arrowGroups": [
            {
                "arrowName": "",
                "count": 0
            }
        ],
        "channel": 0,
        "deviceId": "",
        "storeId": ""
    }
]

响应参数:

参数名称 参数说明 类型 schema
arrowGroups 动线箭头 array ArrowGroup
channel 设备通道号 integer(int32) integer(int32)
deviceId 设备ID string(uuid) string(uuid)
storeId 门店ID string(uuid) string(uuid)

schema属性说明

ArrowGroup

参数名称 参数说明 类型 schema
arrowName 动线箭头名称 string
count 统计数量 integer(int32)

响应状态:

状态码 说明 schema
200 OK 热点流向（动线）数据统计结果

获取热力图

接口描述: 根据门店id和设备id获取对应设备的热力图,返回结果包括设备背景图和热力图,其中背景图为网络地址,热力图为base64转码后的字符

接口地址: https://yd.yunding360.com/openapi/hotspot/heatmap/{storeId}/{deviceId}

请求方式：GET

请求参数：

参数名称 参数说明 in 是否必须 数据类型 schema
channel 设备通道号(如设备为单通道设备时不传) path false integer
deviceId 设备id path true string
endTime 结束时间 body false integer
startTime 开始时间 body false integer
storeId 门店id path true string

响应示例:

{
    "bgImgUrl": "",
    "heatMapBase64Str": ""
}

响应参数:

参数名称 参数说明 类型 schema
bgImgUrl 背景图片地址 string
heatMapBase64Str 热力图Base64 string

响应状态:

状态码 说明 schema
200 OK 热力图