万店掌 开放平台 多门店小时数据 （对应业务平台客流数据）-【兼容PC4,PC5,PC6,PC8】
{ "idx": null }

open.passengerflow.getManyShopsPassengerIndicatorData （多门店小时数据 （对应业务平台客流数据）-【兼容PC4,PC5,PC6,PC8】）

指标说明： 1、进店客流：统计绑定在主出入口下的设备； 2、过店客流：经过门店未进店的客流； 3、店外客流：= 进店客流+过店客流，即进店不进店的都算； 4、出店客流：出店客流（头肩类设备可统计，人脸设备无法统计）； 特殊说明： 使用人脸设备统计客流时，"分析-单项指标"和"对比-多店对比"的"时"维度下，各时段相加与页面"汇总"可能出现不一致情况。原因：以呈现实际客流数据为原则，汇总数据按天去重，一天内出现多次计为1人，各时段数据按小时去重，同一小时内出现多次计入1人，多个小时内出现各时段各计1次。

接口描述 #

环境 接口方法 提交方式 是否需要签名 HTTP请求路由
正式环境 open.passengerflow.getManyShopsPassengerIndicatorData POST true http://cloudapi.ovopark.com/cloud.api

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 是 20 开放平台系统编号，固定为S107 S107
_akey String 是 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 是 100 接口名称 open.passengerflow.getManyShopsPassengerIndicatorData
_sm String 是 100 签名算法 md5,sha1 md5
_requestMode String 是 100 请求方式post,get POST
_version String 是 100 版本号 v1
_timestamp String 是 100 时间戳 yyyyMMddHHmmss格式
_sig String 是 32 签名token 根据签名算法生成，详情见签名算法规则
_format String 否 10 format类型 目前默认仅支持json

业务请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
id		 string √ 100 门店:"S_" + id 组织架构:"O_" + id O_1834
startTime		 string √ 100 开始时间 2020-08-19 00:00:00 (此入参必须按天为单位)
endTime		 string √ 100 结束时间 2020-08-19 23:59:59 (此入参必须按天为单位)
starthour		 int × 11 默认1 10
endhour		 int × 11 默认24 22
timeType		 int × 11 时间类型 1-时 2-天 3-周 4-月 5-季 6-年 趋势的时间纬度 默认是1 2
isOnBusinessTime		 int × 0 1表示营业时间内 0或不传全部数据 0

公共响应参数 #

参数 类型 最大长度 描述 示例值
stat JSON - 网关状态(具体参数描述如下：) 查看
stat.cid String 100 http请求的标识符
stat.code String 100 网关返回码
stat.codename String 100 网关返回码名称
stat.systime String Long 接口调用的当前时间
result String 100 接口返回提示信息
data JSON - 接口调用返回的业务信息(一般是json格式数据，具体数据格式会在业务返回参数中定义) 查看

业务返回参数 #

参数名称 类型 是否一定返回 返回最大长度 描述 示例值
name		 string × 100 门店名称 上海市区一店
depId		 int × 11 门店id 9642
shopId		 string × 100 店铺编号 55247
 ×
    
time		 string × 100 返回时间为时间段的结束点(例如 返回 2021-11-14 01:00:00 指 2021-11-14 00:00:00 ～ 2021-11-14 01:00:00 的客流) 2021-11-14 01:00:00
    
passengerFlow		 int × 11 进店客流：统计绑定在主出入口下的设备； 0
    
outSidePassengerFlow		 int × 11 当有过店客流时，店外客流 = 进店客流+过店客流； 若无过店客流，则不计算店外客流； 0
    
passPassengerFlow		 int × 11 过店客流：经过门店未进店的客流； 0
    
inShopRate		 double × 11 进店率 = 进店客流/店外客流*100% = 进店客流/(进店客流+过店客流)*100% （企业整体进店率不计入未绑定店外客流设备的门店） 0
    
outFlowCount		 int × 11 出店客流 : 出店客流（头肩类设备可统计） 0
    
dressingRate		 double × 11 试衣率 = 试衣间客流/进店客流*100%，即进店顾客中去试衣的比例； 0

公共返回码 #

返回码名称 返回码 返回码描述 解决方案
SUCCESS 0 调用成功
KEY_NOTNULL 1 _akey和不能为空 接口调用时传入_akey参数
KEY_UNLAWFUL 2 _akey不合法 key是非法的,传入正确的key
KEY_HAS_EXPIRED 3 _akey已过期 请续订服务或联系平台管理人员
SIGN_METHOD_NOTNULL 4 _sm参数不能为空 接口调用时传入_sm参数
SIGN_TYPE_NOTEXIST 5 _sm类型不存在 目前仅支持md5,sha1
SIGN_NOTNULL 6 _sig参数不能为空 接口调用时传入_sig参数
SIGN_WRONG 7 无效的签名，请检查参数和签名格式 _sig值根据签名算法生成
METHOD_NOTNULL 8 _mt参数不能为空 接口调用时传入_mt参数
METHOD_NOTEXIST_CODE 9 _mt对应的方法名不存在或未注册进服务 检查_mt方法名和_version版本号对应的方法是否传入错误
REQUESTMODE_NOTNULL 10 _requestMode参数不能为空 接口调用时传入_requestMode参数
APPLICATIONID_NOTNULL 11 _aid参数不能为空 接口调用时传入_aid参数
APPLICATIONID_NOTSAME 12 _aid与当前key不匹配 _aid与_akey必须一一对应
VERSION_NOTNULL 13 _version版本号不能为空 接口调用时传入_version参数
TIMESTAMP_NOTNULL 14 _timestamp时间戳不能为空 接口调用时传入_timestamp参数
TIMESTAMP_FORMAT_ERROR 15 _timestamp时间戳格式化错误 按照yyyyMMddHHmmss格式
TIMESTAMP_OVERTIME 16 _timestamp已失效 _timestamp每次接口调用时重新生成
FORMAT_TYPE_NOTEXIST 17 _format类型不存在 目前仅支持json(默认),xml
API_CALL_REPEAT -100 接口重复调用 接口平台调用异常
API_SYSTEM_CALL_ERROR -500 api调用失败，系统发生异常 接口平台调用异常
UNKNOWN_ERROR -999 开放平台系统异常 重新发起请求

业务返回码 #

返回码名称 返回码 返回码描述
11		 11 11