什么值得买

高佣

wemall

接入步骤

具体内容

step 1:

• 注册穿山甲媒体平台账号。

• 选择"电商联盟"模块，签订合作协议。路径：媒体平台->成长工具->电商联盟->签订合同

step 2:

• 选择“添加应用”，接入应用。没有APP的推广渠道，可以填写一个测试应用填入，穿山甲电商联盟业务中，测试应用是正常结算佣金的。

step 3:

• API 接入

step 4:

• 订单数据查询

（可通过订单api 或穿山甲媒体平台查询）

协议

HTTPS

METHOD

POST

接口域名

ecom.pangolin-sdk-toutiao.com

参数名称

类型

是否必填

示例值

描述

请求header

Content-Type

必填

请求格式类型。必须为"application/json"

请求body(json格式)

app_id

string

是

在穿山甲媒体平台上注册的应用id

timestamp

long

是

秒时间戳，和服务器时间相差超过10分钟会报错。

version

string

否

API协议版本，当前支持"1"。若不传，默认为"1"

sign

string

是

输入参数签名结果

sign_type

String

否

签名算法类型。目前只支持MD5，若不传，默认为MD5

req_id

string

是

唯一id，方便问题排查。如果没有自己的生成规则，推荐按照UUID https://blog.csdn.net/nawenqiang/article/details/82684001

data

string

是

具体的接口报文，为json序列化后的报文。可参考下文具体接口字段。

参数名称

参数类型

参数描述

响应header

Content-Type

响应格式类型, application/json

响应body

code

long

错误码，如果没有异常即为0

desc

string

当错误码不为0时会有值

data

object

具体的接口报文，不同接口结构不同。可参考下文具体接口字段

参数名称

参数类型

是否必须

示例值

参数描述

data对象

page

int

是

商品第几页，从1开始

page_size

int

是

商品每页数量，最大20，最小1

title

string

否

商品关键词

first_cids

Integer array

否

筛选商品一级类目，从商品类目接口可获得一级类目

second_cids

Integer array

否

筛选商品二级类目， 从商品类目接口可获得二级类目

third_cids

Integer array

否

筛选商品三级类目，从商品类目接口可获得三级类目

price_min

int

否

最低价格，包含，单位分。

price_max

int

否

最高价格，不包含，单位分。应保证price_max>=price_min

sell_num_min

int

否

历史销量最小值

sell_num_max

int

否

历史销量最大值。应保证sell_num_max>sell_num_min

search_type

int

否

排序类型：

0 默认排序；

1历史销量排序；

2价格排序；

3佣金排序；

4佣金比例排序。

不填默认为0。

order_type

int

否

0 升序，

1 降序。

不填默认为0。若search_type为0，则此值无意义

cos_fee_min

int

否

最低分佣，单位分

cos_fee_max

int

否

最高分佣，单位分。应保证

cos_ratio_min

int

否

分佣比例百分比乘以100：1.1%，传1.1*100 = 110

cos_ratio_max

int

否

分佣比例百分比乘以100: 1.1%，传1.1*100 = 110

activity_id

int

否

获取活动商品。1返回超值购，0返回全量

package_activity_type

int

否

商品包类型：

1 爆品，

2 团长招商品，

3 两小时榜单，

4 今日榜单

参数字段

参数类型

示例值

参数描述

data对象

total

int

满足搜索条件的商品总数，如果超过2000，则只展示前2000

products

object array

满足搜索条件的商品列表

product对象

product_id

long

商品id

title

string

商品名称

is_kol_product

bool

是否有达人特殊佣金

price

long

商品价格，单位分

in_stock

bool

有无库存

first_cid

long

商品一级类目

second_cid

long

商品二级类目

third_cid

long

商品三级类目

sales

int

商品历史销量

cover

string

商品主图

detail_url

string

商品链接

shop_id

long

商铺id

shop_name

string

商铺名称

coupon_price

long

券后价格，单位分（0或者没传则为原价）

cos_ratio

int

分佣比例，百分比乘以 100，比如 1% 返回 1*100 = 100

cos_fee

int

佣金金额，单位分

activity_id

int

获取活动商品。1: 返回超值购商品；0:返回全量商品

ext

string

一个加密字段，需要在转链接口当中回传

post_free

bool

是否包邮

limit_min_sale

bool

是否多件起购

public_plan_cos_ratio

int

公共计划佣金比例，百分比乘以 100，比如 1% 返回 1*100 = 100

public_plan_detail_url

string

公共计划商品链接

参数名称

参数类型

是否必须

示例值

参数描述

data对象

product_url

string

是

https://www.a.com/products/1

商品url。与商品接口detail_url一致

product_ext

string

否

sdfdjfdlsfj

商品搜索接口返回的product.ext 字段, 尽量填写

external_info

string

否

媒体传递扩展参数的字段， 字符只允许字母大小写、数字、下划线，长度不超过40

share_type

int array

否

[1,2,3,4,5]

转链类型：

1、抖音 deep link；

2、抖音二维码；

3、抖音口令；

4、抖音zlink；

5、ShareLink。

不填默认只有1 【注：不需要二维码请不要填，二维码生成耗时较高】

platform

int

否

[0,1]

0：抖音，1：抖音极速版，不传默认为0

use_coupon

bool

否

true

是否返回商品惠后价领券链接(如果商品有优惠则返回，否则不返回)

参数名称

参数类型

示例值

参数描述

data对象

dy_password

string

抖音口令。当share_type包含3时会返回

dy_qr_code

object

抖音二维码。当share_type包含2时会返回

dy_deeplink

string

抖音deep link。当share_type包含1时会返回

dy_zlink

string

抖音zlink。当share_type包含4时会返回

dy_sharelink

string

抖音sharelink。当share_type包含5时会返回

coupon_link

object

优惠价推广链接

public_plan_product_link_result_info

object

同data对象，公共计划转链信息

dy_qr_code对象

url

string

二维码地址

width

int

二维码宽度

height

int

二维码高度

coupon_link对象

coupon_status

int

0

是否有优惠价&优惠券 0有优惠券 1没有优惠券

qrcode

object

二维码

share_command

string

口令

deeplink

string

deeplink

share_link

string

站外H5领券链接

参数名称

参数类型

是否必须

示例值

参数描述

data对象

product_ids

int array

是

[1234]

商品id列表

参数名称

参数类型

示例值

参数描述

data对象

total

int

100

商品总数

products

object array

商品列表

product对象

product_id

long

123456

商品id

title

string

测试商品

商品名称

is_kol_product

bool

true, false

在穿山甲上是否有达人特殊佣金

price

long

100

商品价格，单位分

cos_ratio

int

100

分佣比例，百分比乘以 100，比如 1% 返回 1*100 = 100

cos_fee

int

10000

佣金金额，单位分

first_cid

int

1

商品一级类目， 可从商品类目接口获得

second_cid

int

2

商品二级类目，可从商品类目接口获得

third_cid

int

3

商品三级类目，可从商品类目接口获得

in_stock

bool

true, false

是否有库存

sales

int

100

商品历史销量

cover

string

商品主图

imgs

string array

["商品轮播图"]

商品轮播图

detail_url

string

商品链接

shop_id

int

商铺id

shop_name

string

商铺名称

comment_score

float

商品评分

comment_num

int

商品评价数目

order_num

int

近30天商品总订单量

view_num

int

近30天商品总浏览量

kol_num

int

近30天推广总达人数

daily_statistics

object array

近30天推广达人数、浏览量、和订单量明细

logistics_info

string

商品物流说明

has_sxt

bool

是否具有短视频随心推资质

shop_total_score

object

coupon_price

long

券后价格，单位分（0或者没传则为原价）

brand_info

object

品牌信息

tags

object

标签信息

available_coupons

object

优惠券列表

commission_type

int

佣金类型

ins_activity_param

string

团长参数

public_plan_cos_ratio

int

公共计划佣金比例，百分比乘以 100，比如 1% 返回 1*100 = 100

public_plan_detail_url

string

公共计划商品链接

daily_statistic对象

date

日期

order_num

当日商品订单量明细

view_num

当日商品浏览量明细

kol_num

当日推广达人数明细

shop_total_score对象

shop_score

商家体验分

product_score

商品体验分

logistics_score

物流体验分

service_score

商家服务分

brand_info对象

brand_id

int

品牌id

brand_name_cn

string

品牌中文名

brand_name_en

string

品牌英文名

tags对象

has_shop_brand_tag

bool

是否有品牌旗舰店标签（[品牌]黑标）

success

bool

获取数据是否成功

available_coupons对象

coupon_type

int

券类型.0 平台券, 1 平台券 2 店铺券 3 主播券

type_desc

string

优惠券类型：平台券/主播券/店铺券

discount_desc

string

优惠内容：满20减1/减1/5折

apply_start_time

string

优惠券领取开始时间

apply_end_time

string

优惠券领取结束时间

validity_type

int

优惠券有效期类型：1固定有效期类型，2浮动有效期类型

use_start_time

string

1固定有效期类型，优惠券使用开始时间

use_end_time

string

1固定有效期类型，优惠券使用结束时间

valid_period

int

2浮动有效期类型，领取优惠券后有效期，单位s

参数名称

参数类型

是否必须

示例值

参数描述

data对象

parent_id

int

否

0

本接口是通过上级类目，查询下级类目。如果要查询一级类目，则该字段填写 0 即可。查询二级类目，输入相应的一级类目即可。若未传，则默认为0

channel

int

否

1

0表示旧类目，1表示新类目

参数名称

参数类型

示例值

参数描述

data对象

total

int

总类目数

category_list

object对象

类目详情

category对象

id

int

类目id

name

string

类目名称

level

int

类目层级，最多三级

参数名称

参数类型

是否必须

示例值

参数描述

data对象

page

int

是

分页index，从1开始

page_size

int

是

分页size，范围(0,100]

sort_by

int

否

排序字段: 1-综合；2-销量；3-佣金率；4-粉丝数。不填默认为1

sort_type

int

否

排序方式：0-降序；1-升序。不填默认为0。若sort_by为1， 则此字段无意义

status

int

否

直播间状态筛选：

0-在播和不在播，

1-在播，

2-不在播。

默认为1，代表只出在播直播间

注：综合排序下直播状态筛选不生效

author_info

string

否

达人昵称/达人uid

need_products

int

否

是否需要返回商品:1-返回，0-不返回。默认为1，代表返回商品信息

注意：必需传 0 ，否则返回数量可能不够

参数名称

参数类型

示例值

参数描述

data对象

total

int

2

符合条件的最大直播间数量

live_infos

object array

直播间信息列表

live_info对象

author_openid

string

直播间主播openid

author_buyin_id

string

直播间主播百应id

author_name

string

昵称

author_pic

string

头像

author_level

int

达人等级

product_category

string array

商品类别

average_gmv

string

场均gmv

fans_num

int

粉丝数量

average_commission_rate

string

平均佣金率

room_id

string

直播间id

gender

string

性别 male/ female/ 未知

ext

string

内部生成的加密字段。直播间转链请求的live_ext应填此字段

products

product object array

直播间挂车的商品信息。

lottery_products

product object array

直播间挂车的福袋商品活动信息。若没有就不返回。会返回当前直播间开播以来开展过的所有福袋活动(包含已过期和正在进行)。

online_num

int

查询时刻在线人数

create_time

int

开播时间戳

product对象

product_id

long

123456

商品id

title

string

测试商品

商品名称

price

long

100

商品价格，单位分

in_stock

bool

true

是否上架, 保证一定上架

first_cid

long

1

商品一级类目

first_cname

string

男装

商品一级类目名称

second_cid

long

2

商品二级类目

second_cname

string

T恤

商品二级类目名称

third_cid

long

3

商品三级类目

third_cname

string

商品三级类目名称

sales

int

100

商品历史销量

cover

string

商品主图

detail_url

string

商品链接

coupon_price

long

直播间展示的最终价格，单位分（0或者没传则为原价）

shop_id

long

商铺id

shop_name

string

商铺名称

cos_ratio

int

新客分佣比例，百分比乘以 100，比如 1% 返回 1*100 = 100。多数用户通常为新人。

新客与老客的区分。如果用户在第一次转链跳转到直播间之前一定时间内就已经关注了该直播间(包含一定时间内关注后又取关)，那么该用户为老客，否则为新客。参见抖客直播间推广结算规则

cos_fee

int

新客佣金金额，单位分

old_fans_cos_ratio

int

老客分佣比例，百分比乘以 100，比如 1% 返回 1*100 = 100。

old_fans_cos_fee

int

老客佣金金额，单位分

is_explaining

bool

是否正在讲解

has_given_product

bool

是否有赠品

available_coupons

available_coupon object array

优惠券信息列表。coupon_price已扣减了优惠券。此列表不包含用户个性化券

lottery_activity_info

lottery_activity_info对象

福袋活动信息。关于福袋活动，可参考福袋活动功能上线通知 。

若想用福袋活动引流，需要注意福袋活动的起始和结束时间，保证福袋活动是正在进行的。

available_coupon对象

coupon_type

int

1

优惠券类型：1 平台券；2 店铺券；3 达人券。

type_desc

string

平台券

券类型描述

discount_desc

string

满50减10券

券描述

lottery_activity_info对象

lottery_activity_id

int

福袋活动id

lottery_product_start_time

福袋活动起始时间戳(北京时间)

lottery_product_end_time

福袋活动结束/开奖时间戳(北京时间)

参数名称

参数类型

是否必须

示例值

参数描述

data对象

author_openid

string

author_openid和author_buyin_id必填其一

直播间主播open_id， 从直播间列表接口返回的author_openid可获得

author_buyin_id

string

直播间主播buyin_id，从直播间列表接口返回的author_buyin_id可获得

external_info

string

否

自定义字段，只允许 数字、字母和_，限制长度为40

live_ext

string

否

直播间列表接口下发的live_info.ext，尽量填写

share_type

int array

否

[1,2,3,4]

转链类型：1、抖音 deep link；2、抖音二维码；3、抖音口令 4、抖音zlink 默认返回抖音deeplink

product_id

int

否

123456

直播间内的某个商品id， 必须来自直播间列表接口内的商品id， 且必须和直播间对应

platform

int

否

[0,1]

0：抖音，1：抖音极速版，不传默认为0

参数名称

参数类型

示例值

参数描述

data对象

dy_password

string

抖音口令

dy_qr_code

json

抖音二维码

dy_deeplink

string

抖音deeplink

dy_zlink

string

抖音zlink。当share_type包含4时会返回

dy_qr_code对象

url

url

二维码地址

with

int

二维码宽度

height

int

二维码高度

字段名

字段类型

字段说明

是否必填

参数限制

data对象

size

int

此次请求拉取数量

如果没有传递order_ids参数，则必填

取值区间： [1, 50]。

cursor

string

上一次相同app_id订单查询返回的游标

如果没有传递order_ids参数，则必填

某个app_id第一次查询应为"0"，后面查询应使用前一次请求返回的Cursor。直到查询返回cursor为""。可用于分批拉取订单

start_time

int

支付的开始时间

如果没有传递order_ids参数，则必填

开始时间不能大于结束时间，且为北京时间的时间戳，单位为秒

end_time

int

支付的结束时间

如果没有传递order_ids参数，则必填

结束时间与开始时间间隔不超过90天

order_ids

string list

订单号

选填

最多支持10个订单号，如果这个字段填了，start_time/end_time/cursor/size不会使用

order_type

int

1-商品分销订单，

2-直播间分销订单，

3-活动类型订单

必填

只能是1或2或3，如果access_type选择2-SDK接入，则此时只能支持查询直播间分销的订单，order_type务必传2；

time_type

string

pay-按照支付时间查询特定时间范围内的订单

update-按照订单更新时间查询特定时间范围内的订单

选填

当使用start_time/end_time/cursor/size生效， 不填时默认为pay

access_type

int

1-API接入方式，用于查询接入乘风计划cps api的订单

2-SDK接入方式，用于查询接入闭环电商或内容直播中直播内流出cps直播间的订单

选填

默认为1，建议不传，使用默认值即可

字段

字段类型

字段说明

colonel_order_info

activity_id

int

团长活动id

institution_id

int

团长机构id

institution_name

string

团长机构名称

字段

字段类型

字段说明

data对象

cursor

string

供查询下一页订单的游标，仅在按时间区间分页查询时才会返回，按订单id查询不会返回。返回为""时代表后面没有订单了。

orders

object list

订单列表

order对象

order_id

string

订单id

app_id

string

应用id

product_id

string

商品id

product_name

string

商品名称

author_account

string

直播间达人昵称，仅直播间分销订单才会有该字段

ads_attribution

string

结算方式, intersect为跨播，directIn为直推

product_img

string

商品图片url

total_pay_amount

int

总付款金额，单位分

pay_success_time

string

支付成功时间

refund_time

string

退款时间

pay_goods_amount

int

预估参与结算金额，单位分。如果有支付优惠，pay_goods_amount会略大于total_pay_amount

estimated_commission

float

预估佣金收入，单位分

ads_real_commission

float

实际可结算佣金金额，单位分

split_rate

float

推广费率，单位万分之一，10代表推广费率为0.10%

after_sales_status

int

售后状态，1-空，2-产生退款

flow_point

string

PAY_SUCC:支付完成

REFUND:退款

SETTLE:结算。此状态代表商家确定会结算佣金

CONFIRM: 确认收货

settle_time

string

结算时间

confirm_time

string

确认收货时间

update_time

string

订单状态更新时间

estimated_tech_service_fee

int

预估技术服务费，为pay_goods_amount*split_rate*0.1。

external_info

string

开发者在转链时自己上传的external_info

media_type_name

string

分销类型名称：Live-直播间，ProductDetail-商品详情，ActivityMaterial-活动页

pid

string

穿山甲唯一pid

shop_id

int

店铺id

shop_name

string

店铺名称

item_num

int

商品数量

material_id

int

活动id

is_risk_order

int

是否风险订单，0-否，1-是

字段名

字段类型

是否必填

示例

参数限制

data对象

external_info

string

否

自定义字段，只允许 数字、字母和_，限制长度为40

material_id

string

是

聚合页类型枚举值

请前往PC端媒体后台，推广选品-活动页分销页面，查看对应活动material_id

product_url

string

否

历史逻辑，待下线。

platform

int

否

回流端标识，0表示抖音，1表示抖音极速版，不填默认为0

extra_params

string

否

{

"tab_id": "1011",

"product_id": "12345"

}

活动页转链自定义参数,json格式,键值都是字符串，product_id用作将指定商品置顶于活动页面。（仅支持超值购、秒杀频道）

cf_task_id

string

否

乘风任务id,若有必填

字段

字段类型

字段说明

data对象

qrcode

json

抖音二维码

share_command

string

抖音口令

deeplink

string

抖音deeplink

zlink

string

抖音zlink

字段名

字段类型

字段说明

是否必填

参数限制

data对象

package_id

string

商品包id，标识一类商品，由穿山甲运营提供

是

不为空

page

int

第几个页面， 从1开始。当前默认每页20个。不应超过页面总数。

是

>=1

字段名

字段类型

字段说明

data对象

product_id_list

int array

商品id列表，返回数量不一定是20个，可能有些id因下架等原因被过滤

total_page_num

int

页面总数

字段名

字段类型

字段说明

是否必填

data对象

command

string

直播间/直播间商品/商品的抖口令

是

external_info

string

（二次转链使用）

媒体传递扩展参数的字段， 字符只允许字母大小写、数字、下划线，长度不超过40

否

platform

int

（二次转链使用）

0：抖音，1：抖音极速版，不传默认为0

否

share_type

int array

（二次转链使用）

转链类型：1、抖音 deep link；2、抖音二维码；3、抖音口令；4、抖音zlink；5、ShareLink。 不填默认只有1 【注：不需要二维码请不要填，二维码生成耗时较高，二次转链如果使用抖口令，请注意抖口令可能携带团长参数，如果只提取口令中的商品id转链，会丢失团长参数】

否

字段名

字段类型

字段说明

是否返回

data对象

command_type

int

抖口令解析出的原始物料类型。

1-商品

2-直播间/直播间商品

3-活动页, 可解析聚合页接口生成的抖口令

一定返回

product_info

object

抖口令解析出的商品信息

当command_type=1时一定返回

live_info

object

抖口令解析出的直播间/直播间商品信息

当command_type=2时一定返回

activity_info

object

抖口令解析出的活动页信息

档command_type=3时一定返回

is_own_command

bool

是否是自己的抖口令

true:属于自己

false:属于其他抖客

空:没有抖客归属的抖口令

解析有抖客归属的抖口令时一定返回

public_plan_product_link_result_info

object

公共计划转链信息

同data对象

product_info对象

product_id

int

商品id

当command_type=1时一定返回

ins_activity_param

string

团长参数

share_info

object

分享物料

live_info对象

author_buyin_id

string

直播间buyin_id

当command_type=2时一定返回

product_id

int

商品id

当command_type=2且是直播间内商品分享产生的抖口令时一定返回

share_info

object

分享物料

activity_info对象

material_id

string

聚合页物料id

当command_type=3时一定返回

extra_params

string

活动页自定义参数

share_info

object

分享物料

share_info对象

deep_link

string

deeplink

share_command

string

抖口令

qrcode

object

二维码

zlink

string

zlink

share_link

string

站外h5链接

Qrcode

url

string

width

int

图片宽度

height

int

图片高度

字段名

字段类型

字段说明

是否必填

data对象

Filters

map

过滤器

• key为string，value为FilterItem
• FilterItem为结构化数据，包含字段Value、ConditionOperator
• Value为string数组
• ConditionOperator为条件，类型为int，默认为7，即为"IN"，表示在Value这个字符串数组中
• enum ConditionOperator { EQ = 1 LT = 2 LE = 3 GT = 4 GE = 5 NE = 6 IN = 7 NOT_IN = 8 BETWEEN = 9 MATCH_IN = 10 MATCH_PHRASE = 11 IS_NULL = 12 IS_NOT_NULL = 13 LIKE = 14 }
• key
• DateType，指返回的数据聚合程度，value支持枚举：day
• StartDate，指时间区间的起始时间，不可大于结束时间，不可早于2022-08-01，格式为2006-01-02
• EndDate，指时间区间的结束时间，不能小于起始时间，时间区间不能超过120天限制，格式为2006-01-02
• PidType，指分销类型，value有三种枚举"api_kol_pid"、"api_agency_pid、"live_agency_pid"
• api_kol_pid，API 接入渠道-商品分销
• api_agency_pid，API 接入渠道-直播间分销
• live_agency_pid，SDK 直播渠道-直播间分销
• SiteIds，指应用ID列表，用于过滤，value传空数组或不传此key，默认返回全部应用的数据

是

Dimensions

string数组

聚合维度，如果是查cpa数据总览，可不传；如果是查cpa明细数据，可固定传"Date"，"SiteIds"，"PidType"

否

Pagination

Pagination

分页相关，不传默认返回所有数据记录，最大数量为1e4

否

OrderField

string

排序字段，不传默认按时间倒序排列。可传"Date"、"SiteIds"、"FirstPurchaseUserCount"

否

OrderType

string

排序字段，asc代表升序，desc代表降序

否

IsChart

bool

返回的数据格式类型，true代表折线图，false代表表格；总览数据固定传true，明细数据固定传false

否

Pagination对象

Current

int

当前页

是

PageSize

int

页大小

是

字段名

字段类型

字段说明

data对象

ReportInfo

ReportInfo

指标数据

PageInfo

Pagination

分页相关

ReportInfo对象

ReportList

ReportItem数组

代表每条数据，已排序

Summary

ReportItem

ReportList汇总后数据

ReportItem对象

StartDate

string

起始时间

EndDate

string

结束时间

SiteId

string

应用id

PidType

string

分销类型；如果是查总览数据，则为空；如果是查明细数据，则因为入参Dimensions固定传递了PidType，所以此处以分销类型维度返回数据

FirstPurchaseUserCount

string

新用户数，重要字段

Pagination对象

Current

int

当前页

是

PageSize

int

页大小

是

Total

int

数据量

字段名

字段类型

字段说明

是否必填

data对象

Filters

map

过滤器

• key为string，value为FilterItem
• FilterItem为结构化数据，包含字段Value、ConditionOperator
• Value为string数组
• ConditionOperator为条件，类型为int，默认为7，即为"IN"，表示在Value这个字符串数组中
• enum ConditionOperator { EQ = 1 LT = 2 LE = 3 GT = 4 GE = 5 NE = 6 IN = 7 NOT_IN = 8 BETWEEN = 9 MATCH_IN = 10 MATCH_PHRASE = 11 IS_NULL = 12 IS_NOT_NULL = 13 LIKE = 14 }
• key
• DateType，指返回的数据聚合程度，value支持枚举：day
• StartDate，指时间区间的起始时间，不可大于结束时间，不可早于2022-08-01，格式为2006-01-02
• EndDate，指时间区间的结束时间，不能小于起始时间，时间区间不能超过120天限制，格式为2006-01-02
• PidType，指分销类型，value有三种枚举"api_kol_pid"、"api_agency_pid、"live_agency_pid"
• api_kol_pid，API 接入渠道-商品分销
• api_agency_pid，API 接入渠道-直播间分销
• live_agency_pid，SDK 直播渠道-直播间分销
• SiteIds，指应用ID列表，用于过滤，value传空数组或不传此key，默认返回全部应用的数据

是

Dimensions

string数组

聚合维度，如果是查cpa数据总览，可不传；如果是查cpa明细数据，可固定传"Date"，"SiteIds"，"PidType"

否

Pagination

Pagination

分页相关，不传默认返回所有数据记录，最大数量为1e4

否

OrderField

string

排序字段，不传默认按时间倒序排列。可传"Date"、"SiteIds"、"FirstPurchaseUserCount"

否

OrderType

string

排序字段，asc代表升序，desc代表降序

否

IsChart

bool

返回的数据格式类型，true代表折线图，false代表表格；总览数据固定传true，明细数据固定传false

否

Pagination对象

Current

int

当前页

是

PageSize

int

页大小

是

字段名

字段类型

字段说明

data对象

ReportInfo

ReportInfo

指标数据

PageInfo

Pagination

分页相关

ReportInfo对象

ReportList

ReportItem列表

代表每条数据，已排序

Summary

ReportItem

ReportList汇总后数据

ReportItem对象

StartDate

string

起始时间

EndDate

string

结束时间

SiteId

string

应用id

PidType

string

分销类型；如果是查总览数据，则为空；如果是查明细数据，则因为入参Dimensions固定传递了PidType，所以此处以分销类型维度返回数据

CreatedOrderAmount

string

所有创建订单的gmv数值

RefundedOrderAmount

string

所有退款订单的gmv数值(30天，单位：元)

RealOrderAmount

string

真实结算订单的gmv数值(30天，单位：元)

Pagination对象

Current

int

当前页

PageSize

int

页大小

Total

int

数据量

字段名

字段类型

字段说明

是否必填

data对象

page

int

页数，从1开始

是

page_size

int

每页订单数目，最大为100

是

start_date

string

查询开始日期，格式：20230308，奖励订单只保存近30天的订单

否

end_date

string

查询结束日期，格式：20230308，奖励订单只保存近30天的订单

否

distribution_type

int

默认全部，0:全部 1:商品分销 2: 直播间分销 3: mix自建活动页分销 4:频道页分销 99:其他

否

字段名

字段类型

字段说明

data对象

reward_orders

List<RewardOrder>

奖励订单信息

total

int

查询的奖励订单总数

RewardOrder对象

external_info

string

扩展参数

pay_date

string

成交日期

promotion_info

string

推广位信息

reward_order_id

string

奖励订单ID

product_id

string

成交商品ID

product_name

string

成交商品名称

pay_amount

int

成交金额

reward_type

string

奖励类型：拉新/召回

字段名

字段类型

字段说明

是否必填

data对象

product_url

string

商品链接

是

字段名

字段类型

字段说明

data对象

is_coupon_product

bool

是否包含优惠券

coupons

List<ExclusiveCouponInfo>

优惠券信息

ExclusiveCouponInfo对象

coupon_type

int

优惠券类型 0：无效券类型 1：抖客团长渠道券

status

int

优惠券状态 1 新建 2 生效 3 过期 4 失效 5 删除

discount

int

折扣券折扣，8.5折则为85