淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
query	IndexEffectiveDataQueryDto	必须			查询对象
└ biz_type String 必须 isvmsg 场景描述 └ end_date String 必须 2021-10-17 查询的截止时间 └ biz_id String 必须 1234 场景id └ source String 必须 fromisv 调用来源 └ channel_id Number 必须 15 渠道 └ start_date String 必须 2021-10-19 查询的开始时间 └ track_data_from String 可选 sms 扩展使用 └ ext_info String 可选 "strategyId":"111" 扩展字段

名称	类型	示例值	描述
result	Result	{}	接口返回model
└ msg String 入参非法信息 └ result String {} 业务结果 └ code Number 1001 code └ success Boolean false 是否成功 └ result_code String 1231 返回码 └ count Number 1234 总数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CrmIndexEffectivieDataGetRequest req = new CrmIndexEffectivieDataGetRequest();
CrmIndexEffectivieDataGetRequest.IndexEffectiveDataQueryDto obj1 = new CrmIndexEffectivieDataGetRequest.IndexEffectiveDataQueryDto();
obj1.setBizType("isvmsg");
obj1.setEndDate("2021-10-17");
obj1.setBizId("1234");
obj1.setSource("fromisv");
obj1.setChannelId(15L);
obj1.setStartDate("2021-10-19");
obj1.setTrackDataFrom("sms");
obj1.setExtInfo("\"strategyId\":\"111\"");
req.setQuery(obj1);
CrmIndexEffectivieDataGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CrmIndexEffectivieDataGetRequest req = new CrmIndexEffectivieDataGetRequest();
CrmIndexEffectivieDataGetRequest.IndexEffectiveDataQueryDtoDomain obj1 = new CrmIndexEffectivieDataGetRequest.IndexEffectiveDataQueryDtoDomain();
obj1.BizType = "isvmsg";
obj1.EndDate = "2021-10-17";
obj1.BizId = "1234";
obj1.Source = "fromisv";
obj1.ChannelId = 15L;
obj1.StartDate = "2021-10-19";
obj1.TrackDataFrom = "sms";
obj1.ExtInfo = "\"strategyId\":\"111\"";
req.Query_ = obj1;
CrmIndexEffectivieDataGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CrmIndexEffectivieDataGetRequest;
$query = new IndexEffectiveDataQueryDto;
$query->biz_type="isvmsg";
$query->end_date="2021-10-17";
$query->biz_id="1234";
$query->source="fromisv";
$query->channel_id="15";
$query->start_date="2021-10-19";
$query->track_data_from="sms";
$query->ext_info="\"strategyId\":\"111\"";
$req->setQuery(json_encode($query));
$resp = $c->execute($req, $sessionKey);

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=taobao.crm.index.effectivie.data.get' \
-d 'partner_id=apidoc' \
-d 'session=bb898e10-a93f-470a-b4a8-8ba57c9bc0ca' \
-d 'sign=CEA345D16ABBEFDF3C705909A26E0FFA' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-18+16%3A37%3A54' \
-d 'v=2.0' \
-d 'query=null'

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

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

req.query=""
try:
	resp= req.getResponse(sessionkey)
	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,"taobao.crm.index.effectivie.data.get");
add_param(pRequest,"query","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('taobao.crm.index.effectivie.data.get', {
	'query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<crm_index_effectivie_data_get_response>
    <result>
        <msg>入参非法</msg>
        <result>{}</result>
        <code>1001</code>
        <success>false</success>
        <result_code>1231</result_code>
        <count>1234</count>
    </result>
</crm_index_effectivie_data_get_response>

{
    "crm_index_effectivie_data_get_response":{
        "result":{
            "msg":"入参非法",
            "result":"{}",
            "code":1001,
            "success":false,
            "result_code":"1231",
            "count":1234
        }
    }
}

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

taobao.crm.index.effectivie.data.get (指标的效果数的查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ