Register

open.passengerflow.getManyShopsPassengerIndicatorData （获取多门店客流小时数据）

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

Interface Description #

Environment Interface Method Submission Method Requires Signature The identifier of the http request
Formal environment open.passengerflow.getManyShopsPassengerIndicatorData POST true https://openapi.opretail.com/cloud.api

Public Request Parameters #

Parameter Type Required Max Length Description Example Value
_aid String Yes 20 Open platform system ID, fixed as S107 S107
_akey String Yes 20 Developer key assigned by Wanzdianzhang Open Platform to third parties Obtained after authenticating platform developer
_mt String Yes 100 Interface name open.passengerflow.getManyShopsPassengerIndicatorData
_sm String Yes 100 Signature algorithm md5, sha1 md5
_requestMode String Yes 100 Request method post, get POST
_version String Yes 100 Version number v1
_timestamp String Yes 100 Timestamp yyyyMMddHHmmss format
_sig String Yes 32 Signature token Generated according to signature algorithm, see signature algorithm rules for details
_format String No 10 Format type Currently only json is supported by default

Business Request Parameters #

Parameter Type Required Max Length Description Example Value
id string √ 100 Store :"S_" + ID Organizational structure :"O_" + ID O_1834
startTime string √ 100 The start time 2020-08-19 00:00:00
endTime string √ 100 The end of time 2020-08-19 23:59:59
starthour int × 11 The default 0 0
endhour int × 11 The default 24 24
timeType int × 11 Time type 1- Hour 2- Day 3- Week April - Month 5- Season 6- Year The default time latitude of the trend is 1 2

Public Response Parameters #

Parameter Type Max Length Description Example Value
stat JSON - Gateway status (specific parameters are described as follows: View
stat.cid String 100 The identifier of the http request
stat.code String 100 Gateway return code
stat.codename String 100 Gateway return code name
stat.systime String Long The current time of the interface call
result String 100 The interface returns prompt information
data JSON - Business information returned by the interface call (usually in JSON format, the specific data format will be defined in the business return parameters) View

Business Response Parameters #

apiDetail.parameterName Type Required Max Length Description Example Value
name string × 100 shop name test store
depId int × 11 Store id 9642
shopId string × 100 Store Code 55247
×
time string × 100 time 2021-11-14 01:00:00
passengerFlow int × 11 Walk-in Count: Count the equipment bound under the main entrance and exit; 0
outSidePassengerFlow int × 11 Outside passenger flow = Walk-in Count +Passing Store Count, that is, not only count walk in, but also count those who passing the store but not enter the store. 0
passPassengerFlow int × 11 Passing Store Count = passenger flow passing the store but not entering the store; 0
inShopRate double × 11 Walk-in Rate = Walk-in Count/Outside passenger flow*100% =Walk-in Count/(Walk-in Count +Passing Store Count)*100% (the overall enterprise Walk-in Rate does not include the stores that are not bound with outside people counting device) 0
outFlowCount int × 11 Walk-out Count: Walk-out Count(head and shoulder equipment can be counted, facial equipment cannot be counted) 0
dressingRate double × 11 Fitting Rate = Customes flow in the fitting room/ Walk-in Count*100%, that is, the proportion of in-store customers who go for fitting 0

Public Return Codes #

Return code name Return code Return Code Description Solution
SUCCESS 0 Call success
KEY_NOTNULL 1 _akey cannot be empty Pass in the _akey parameter when calling the interface
KEY_UNLAWFUL 2 _akey is illegal The key is illegal, enter the correct key
KEY_HAS_EXPIRED 3 _akey has expired Please renew your service or contact the platform administrator
SIGN_METHOD_NOTNULL 4 The _sm parameter cannot be empty Pass in the _sm parameter when calling the interface
SIGN_TYPE_NOTEXIST 5 _sm type does not exist Currently only supports md5, sha1
SIGN_NOTNULL 6 The _sig parameter cannot be empty Pass in the _sig parameter when calling the interface
SIGN_WRONG 7 Invalid signature, please check the parameters and signature format The _sig value is generated according to the signature algorithm
METHOD_NOTNULL 8 apiDetail.mtParameterCannotBeEmpty apiDetail.passInTheMtParameterWhenCallingTheInterface
METHOD_NOTEXIST_CODE 9 The method name corresponding to _mt does not exist or is not registered in the service Check whether the method corresponding to the _mt method name and _version version number has an error in passing
REQUESTMODE_NOTNULL 10 The _requestMode parameter cannot be empty Pass in the _requestMode parameter when calling the interface
APPLICATIONID_NOTNULL 11 _aid parameter cannot be empty Pass in the _aid parameter when calling the interface
APPLICATIONID_NOTSAME 12 _aid does not match the current key _aid and _akey must correspond one to one
VERSION_NOTNULL 13 _version version number cannot be empty Version number
TIMESTAMP_NOTNULL 14 _timestamp timestamp cannot be empty Pass in the _timestamp parameter when calling the interface
TIMESTAMP_FORMAT_ERROR 15 _timestamp timestamp format error Follow the yyyyMMddHHmmss format
TIMESTAMP_OVERTIME 16 _timestamp has expired _timestamp is regenerated each time the interface is called
FORMAT_TYPE_NOTEXIST 17 _format type does not exist Currently only supports json (default), xml
API_CALL_REPEAT -100 Interface duplicate call Interface platform call exception
API_SYSTEM_CALL_ERROR -500 API call failed, system exception Interface platform call exception
UNKNOWN_ERROR -999 Open platform system exception Reinitiate request

Business Return Codes #

Return code name Return code Return Code Description
success 200 success