万店掌 开放平台 获取开放平台组织架构 多门店客流指标汇总数据趋势

open.shopweb.passengerFlow.getPassengerIndicatorDataTrend (获取开放平台组织架构 多门店客流指标汇总数据趋势)

获取开放平台组织架构 多门店客流指标汇总数据趋势

接口描述#

环境接口方法提交方式是否需要签名HTTP请求路由
正式环境open.shopweb.passengerFlow.getPassengerIndicatorDataTrendGETtruehttp://cloudapi.ovopark.com/cloud.api

公共请求参数#

参数类型是否必填最大长度描述示例值
_aidString20开放平台系统编号,固定为S107S107
_akeyString20万店掌开放平台分配给第三方的开发者key认证平台开发者后获取
_mtString100接口名称open.shopweb.passengerFlow.getPassengerIndicatorDataTrend
_smString100签名算法 md5,sha1md5
_requestModeString100请求方式post,getGET
_versionString100版本号v1
_timestampString100时间戳yyyyMMddHHmmss格式
_sigString32签名token根据签名算法生成,详情见签名算法规则
_formatString10format类型目前默认仅支持json

业务请求参数#

参数类型是否必填最大长度描述示例值
id
string100门店:"S_" + id 组织架构:"O_" + idS_111222
startTime
string100开始时间2020-08-19 00:00:00
endTime
string100结束时间2021-09-16 23:59:59
timeType
int×11时间类型 1-时 2-天 3-周 4-月 5-季 6-年 趋势的时间纬度1
starthour
int×11默认11
endhour
int×11默认2424

公共响应参数#

参数类型最大长度描述示例值
statJSON-网关状态(具体参数描述如下:)查看
stat.cidString100http请求的标识符
stat.codeString100网关返回码
stat.codenameString100网关返回码名称
stat.systimeStringLong接口调用的当前时间
resultString100接口返回提示信息
dataJSON-接口调用返回的业务信息(一般是json格式数据,具体数据格式会在业务返回参数中定义)查看

业务返回参数#

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

公共返回码#

返回码名称返回码返回码描述解决方案
SUCCESS0调用成功
KEY_NOTNULL1_akey和不能为空接口调用时传入_akey参数
KEY_UNLAWFUL2_akey不合法key是非法的,传入正确的key
KEY_HAS_EXPIRED3_akey已过期请续订服务或联系平台管理人员
SIGN_METHOD_NOTNULL4_sm参数不能为空接口调用时传入_sm参数
SIGN_TYPE_NOTEXIST5_sm类型不存在目前仅支持md5,sha1
SIGN_NOTNULL6_sig参数不能为空接口调用时传入_sig参数
SIGN_WRONG7无效的签名,请检查参数和签名格式_sig值根据签名算法生成
METHOD_NOTNULL8_mt参数不能为空接口调用时传入_mt参数
METHOD_NOTEXIST_CODE9_mt对应的方法名不存在或未注册进服务检查_mt方法名和_version版本号对应的方法是否传入错误
REQUESTMODE_NOTNULL10_requestMode参数不能为空接口调用时传入_requestMode参数
APPLICATIONID_NOTNULL11_aid参数不能为空接口调用时传入_aid参数
APPLICATIONID_NOTSAME12_aid与当前key不匹配_aid与_akey必须一一对应
VERSION_NOTNULL13_version版本号不能为空接口调用时传入_version参数
TIMESTAMP_NOTNULL14_timestamp时间戳不能为空接口调用时传入_timestamp参数
TIMESTAMP_FORMAT_ERROR15_timestamp时间戳格式化错误按照yyyyMMddHHmmss格式
TIMESTAMP_OVERTIME16_timestamp已失效_timestamp每次接口调用时重新生成
FORMAT_TYPE_NOTEXIST17_format类型不存在目前仅支持json(默认),xml
API_CALL_REPEAT-100接口重复调用接口平台调用异常
API_SYSTEM_CALL_ERROR-500api调用失败,系统发生异常接口平台调用异常
UNKNOWN_ERROR-999开放平台系统异常重新发起请求

业务返回码#

返回码名称返回码返回码描述
待维护
待维护待维护