文档中心 > API类目 > 数据服务API

koubei.marketing.data.customreport.batchquery (自定义报表规则列表分页查询接口)

分页查询自定义数据报表规则列表

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.marketing.data.customreport.batchquery
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 256 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
page_no String 可选 10 当前页号,默认为1 1
page_size String 可选 2 每页条目数,默认为20,最大为30 20

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
report_condition_list CustomReportCondition [] 必填 - 分页输出自定义开放数据规则列表
  • └ condition_key
  • String
  • 选填
  • 64
  • 规则KEY-为空则为创建规则,否则更新规则
  • 20000131311113
  • └ name
  • String
  • 必填
  • 128
  • 自定义报表名称
  • 最近三天会员信息报表
  • └ memo
  • String
  • 必填
  • 1024
  • 规则描述
  • 该报表可统计最近三天的会员信息
  • data_tags
  • DataTag []
  • 必填
  • 65535
  • 明细数据标签
  • └ code
  • String
  • 必填
  • 64
  • 标签CODE
  • orpt_umct_trade_cnt
  • └ aggregate
  • String
  • 必填
  • 16
  • 聚合方式NONE,COUNT,COUNT_DISTINCT,DISTINCT,MIN,MAX,SUM
  • SUM
  • └ alias
  • String
  • 选填
  • 64
  • 列别名
  • trade
  • └ group_tags
  • String
  • 必填
  • 1024
  • 分组数据标签集合
    注意:这个是JSON数组,必须以[开头,以]结尾,[]外层不能加双引号"",正确案例["orpt_ubase_age","orpt_ubase_birthday_mm"],错误案例:"["orpt_ubase_age","orpt_ubase_birthday_mm"]"
  • ["orpt_ubase_age","orpt_ubase_birthday_mm"]
  • └ sort_tags
  • String
  • 选填
  • 1024
  • 排序数据标签集合
    注意:这个是JSON数组,必须以[开头,以]结尾,[]外层不能加双引号"",正确案例[{"code":"orpt_ubase_age","sortBy":"DESC"}],错误案例:"[{"code":"orpt_ubase_age","sortBy":"DESC"}]"
  • [{"code":"orpt_ubase_age","sortBy":"DESC"}]
  • filter_tags
  • FilterTag []
  • 选填
  • 65535
  • 分组过滤条件
  • └ code
  • String
  • 必填
  • 64
  • 过滤条件的标签code
  • orpt_ubase_age
  • └ filter_items
  • String
  • 必填
  • 10240
  • 分组过滤条件
    注意:这个是JSON数组,必须以[开头,以]结尾,[]外层不能加双引号"",正确案例[{"operate": "EQ","value": "1" }],错误案例:"[{"operate": "EQ","value": "1" }]"
  • [{"operate": "EQ","value": "1" }]

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMarketingDataCustomreportBatchqueryRequest request = new KoubeiMarketingDataCustomreportBatchqueryRequest();
request.setBizContent("{" +
"\"page_no\":\"1\"," +
"\"page_size\":\"20\"" +
"  }");
KoubeiMarketingDataCustomreportBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"koubei_marketing_data_customreport_batchquery_response":{
		"msg":"Success",
		"report_condition_list":[
			{
				"sort_tags":"[{\"code\":\"orpt_ubase_age\",\"sortBy\":\"DESC\"}]",
				"filter_tags":[
					{
						"code":"orpt_ubase_age",
						"filter_items":"[{\"operate\": \"EQ\",\"value\": \"1\" }]"
					}
				],
				"name":"最近三天会员信息报表",
				"group_tags":"[\"orpt_ubase_age\",\"orpt_ubase_birthday_mm\"]",
				"memo":"该报表可统计最近三天的会员信息",
				"data_tags":[
					{
						"code":"orpt_umct_trade_cnt",
						"alias":"trade",
						"aggregate":"SUM"
					}
				],
				"condition_key":"20000131311113"
			}
		],
		"code":"10000"
	}
}

异常示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"koubei_marketing_data_customreport_batchquery_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	}
}

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 稍后重试
REQ_VALIDATE_ERROR 入参格式不正确,请检查入参 调整参数重试
REQ_VALIDATE_ERROR page_num非法 调整参数重试
REQ_VALIDATE_ERROR page_size非法 调整参数重试
CUSTOMREPORT_BATCH_QUERY_FAIL query data failed 调整参数重试
CUSTOMREPORT_BATCH_QUERY_FAIL 开放规则分页参数非法 调整参数重试

公共错误码

返回
顶部