淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
param	HeatMapRequest	可选			param
└ hierach_node_id String 可选 1 楼层 └ end_date String 可选 20220512 结束时间 └ tenant_code String 可选 tenantCode 租户 └ type Number 可选 1 topN/stay 枚举 └ biz_id String 可选 bizId 业务id/出入口id └ end_hour Number 可选 1 结束小时 └ field String 可选门店门店 └ start_hour Number 可选 2 开始小时 └ start_date String 可选 20220512 开始日期

名称	类型	示例值	描述
result	HeatMapFieldSessionDecathlonVO []		result
└ date String 20230402 日期 └ area_id String 区域id 区域id area_coordinate HeatMapCoordinateVO [] 区域坐标 └ map_x String 2.22222 x坐标 └ map_y String 3.3333 y坐标 └ time Number 1725679750 时间戳 track_let HeatMapCoordinateVO [] 脚点坐标List └ map_x String 2.22222 x坐标 └ map_y String 2.22222 y坐标 └ time Number 1725679750 时间戳 └ stay_len String 停留时长停留时长 └ hierarchy_node_id String 楼层楼层 └ session_id String session_id session_id └ segment Number segment segment └ entiy_id String 业务id 业务id
is_success	Boolean	true	是否成功
req_id	Boolean	req_id	req_id
response_err_code	ErrorCode		返回异常信息
└ error_code Number 400 错误码 └ error_msg String 错误信息错误信息
message	String	message	message

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDeepvisionHeatmapDecathlonTopnStayQueryRequest req = new AlibabaDeepvisionHeatmapDecathlonTopnStayQueryRequest();
AlibabaDeepvisionHeatmapDecathlonTopnStayQueryRequest.HeatMapRequest obj1 = new AlibabaDeepvisionHeatmapDecathlonTopnStayQueryRequest.HeatMapRequest();
obj1.setHierachNodeId("1");
obj1.setEndDate("20220512");
obj1.setTenantCode("tenantCode");
obj1.setType(1L);
obj1.setBizId("bizId");
obj1.setEndHour(1L);
obj1.setField("门店");
obj1.setStartHour(2L);
obj1.setStartDate("20220512");
req.setParam(obj1);
AlibabaDeepvisionHeatmapDecathlonTopnStayQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDeepvisionHeatmapDecathlonTopnStayQueryRequest req = new AlibabaDeepvisionHeatmapDecathlonTopnStayQueryRequest();
AlibabaDeepvisionHeatmapDecathlonTopnStayQueryRequest.HeatMapRequestDomain obj1 = new AlibabaDeepvisionHeatmapDecathlonTopnStayQueryRequest.HeatMapRequestDomain();
obj1.HierachNodeId = "1";
obj1.EndDate = "20220512";
obj1.TenantCode = "tenantCode";
obj1.Type = 1L;
obj1.BizId = "bizId";
obj1.EndHour = 1L;
obj1.Field = "门店";
obj1.StartHour = 2L;
obj1.StartDate = "20220512";
req.Param_ = obj1;
AlibabaDeepvisionHeatmapDecathlonTopnStayQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDeepvisionHeatmapDecathlonTopnStayQueryRequest;
$param = new HeatMapRequest;
$param->hierach_node_id="1";
$param->end_date="20220512";
$param->tenant_code="tenantCode";
$param->type="1";
$param->biz_id="bizId";
$param->end_hour="1";
$param->field="门店";
$param->start_hour="2";
$param->start_date="20220512";
$req->setParam(json_encode($param));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.deepvision.heatmap.decathlon.topn.stay.query' \
-d 'partner_id=apidoc' \
-d 'sign=970564AA2F3C37AC86C501100AE1F105' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-06+11%3A15%3A01' \
-d 'v=2.0' \
-d 'param=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaDeepvisionHeatmapDecathlonTopnStayQueryRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.param="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.deepvision.heatmap.decathlon.topn.stay.query");
add_param(pRequest,"param","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.deepvision.heatmap.decathlon.topn.stay.query', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_deepvision_heatmap_decathlon_topn_stay_query_response>
    <result>
        <heat_map_field_session_decathlon_v_o>
            <date>20230402</date>
            <area_id>区域id</area_id>
            <area_coordinate>
                <heat_map_coordinate_v_o>
                    <map_x>2.22222</map_x>
                    <map_y>3.3333</map_y>
                    <time>1725679750</time>
                </heat_map_coordinate_v_o>
            </area_coordinate>
            <track_let>
                <heat_map_coordinate_v_o>
                    <map_x>2.22222</map_x>
                    <map_y>2.22222</map_y>
                    <time>1725679750</time>
                </heat_map_coordinate_v_o>
            </track_let>
            <stay_len>停留时长</stay_len>
            <hierarchy_node_id>楼层</hierarchy_node_id>
            <session_id>session_id</session_id>
            <segment>segment</segment>
            <entiy_id>业务id</entiy_id>
        </heat_map_field_session_decathlon_v_o>
    </result>
    <is_success>true</is_success>
    <req_id>req_id</req_id>
    <response_err_code>
        <error_code>400</error_code>
        <error_msg>错误信息</error_msg>
    </response_err_code>
    <message>message</message>
</alibaba_deepvision_heatmap_decathlon_topn_stay_query_response>

{
    "alibaba_deepvision_heatmap_decathlon_topn_stay_query_response":{
        "result":{
            "heat_map_field_session_decathlon_v_o":[
                {
                    "date":"20230402",
                    "area_id":"区域id",
                    "area_coordinate":{
                        "heat_map_coordinate_v_o":[
                            {
                                "map_x":"2.22222",
                                "map_y":"3.3333",
                                "time":1725679750
                            }
                        ]
                    },
                    "track_let":{
                        "heat_map_coordinate_v_o":[
                            {
                                "map_x":"2.22222",
                                "map_y":"2.22222",
                                "time":1725679750
                            }
                        ]
                    },
                    "stay_len":"停留时长",
                    "hierarchy_node_id":"楼层",
                    "session_id":"session_id",
                    "segment":segment,
                    "entiy_id":"业务id"
                }
            ]
        },
        "is_success":true,
        "req_id":req_id,
        "response_err_code":{
            "error_code":400,
            "error_msg":"错误信息"
        },
        "message":"message"
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

天眼工作室API

alibaba.deepvision.heatmap.decathlon.topn.stay.query (迪卡侬TopN/停留热力)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ