安全应用范围枚举

名称	描述
PAYMENT_RESULT	支付有礼
XLIGHT	繁星激励&&灯火
MESSAGE	消息
MERCHANT_MEMBER	会员
SEARCH_BOX	搜索直达
PROMO_LAYER	弹层控制台

标签说明

私域资产标签，需要传资产所属的(会员卡模板 ID、商家生活号 ID、小程序 ID），具体传值说明如下。

标签名称	标签可选范围 ID(tagOptionCategoryId)	传值说明
商家会员	4300008	会员卡模板 ID
商家生活号	4300019	商家生活号 ID
消息	-	-
小程序行为	2500009	小程序 ID
小程序订阅消息	4800002
小程序收藏用户	5200006

看板分析不同 scene_code 查询

接口：alipay.merchant.qipan.board.query（看板分析）。

scene_code 参数含义总览

看板 scene_code 参数	说明	对应支付宝商家平台模块
asset_overview	查询资产总览和构成，包括累计总用户、访问用户、互动用户（包含小程序收藏、消息订阅、生活号关注、加入商家群）、会员、支付用户和导入用户的累计数量。另外还有每种用户当天的绝对数值增量、总用户资产的近 7 日新增和近 30 日新增。
asset_type_num	查询某日发生对应行为的用户数量，对应行为包括：访问、小程序收藏、消息订阅、生活号关注、加入商家群、入会、支付
crowd_overview（人群概览数据）	人群概览数据看板，包括人群用户数范围、近 30 天访问占比、近 30天支付占比、近 30 日客单价、近 30 日人均支付频次。

查询资产总览和构成（scene_code=asset_overview）

入参说明

参数	说明
scene_code	asset_overview
request_params	report_date	数据日期
exclude_import	总用户资产中是否要排除导入用户，"true"表示排除，其他情况都是不排除导入用户，即包含导入用户。

{
    "scene_code":"asset_overview",
    "request_params":{
        "report_date":"20230103",
        "exclude_import":"true"
    }
}

查询单日对应行为用户（scene_code=asset_type_num）

入参说明

参数	说明
scene_code	asset_type_num
request_params	report_date	数据日期

{
    "scene_code":"asset_type_num",
    "request_params":{
        "report_date":"20221214"
    }
}

返回参数说明：

返回 8 类用户数量：访问、互动、小程序收藏、消息订阅、生活号关注、加入商家群、入会、支付。其中互动用户是四类互动用户去重后的数量。但是导入用户不是用户行为，该接口不返回昨日导入用户数量。

查询人群用户概览（scene_code=crowd_overview）

入参说明

参数	说明
scene_code	asset_overview
request_params	report_date	数据日期
crowd_id	人群id

{
    "scene_code":"crowd_overview",
    "request_params":{
        "report_date":"20221214",
        "crowd_id":"8549881520405121279"
    }
}

趋势分析不同 index_key 查询

接口： alipay.merchant.qipan.trend.query（趋势分析）。

index_key参数含义总览

趋势图index_key	说明	对应支付宝商家平台模块
total_users	用户概览-我的用户资产部分的趋势图
new_user_num	用户洞察-我的用户资产-各种关系类型下“当日xx用户”部分的数据趋势图
pay_users_perc	用户洞察-我的用户资产-各种关系类型下“累计xx用户当日支付占比”部分的数据趋势图
user_indications	用户洞察-我的用户资产-各种关系类型下其他指标数据的趋势图，具体见user_indications一节的说明。

查询总用户资产趋势（index_key=total_users）

入参说明

参数	说明
index_key	total_users
request_params	start_date	趋势图开始时间，如 20221212
end_date	趋势图结束时间，如 20221231
exclude_import	总用户资产中是否要排除导入用户，"true"表示排除，其他情况都是不排除导入用户，即包含导入用户

示例

{
    "index_key":"total_users",
    "request_params":{
        "end_date":"20221130",
        "start_date":"20221229",
        "exclude_import":"true"
    }
}

查询单日行为用户趋势（index_key=new_user_num）

入参说明

参数	说明
index_key	new_user_num
request_params	dim	时间维度day：自然日week：自然周（周一到周日）month：自然月（每个月 1 号到最后一天）
start_date	趋势图开始时间，如 20221212
end_date	趋势图结束时间，如 20221231
relation_type	本场景不支持互动和导入用户的查询。互动用户是具体 4 类用户的总和（收藏、订阅、关注、入群），导入用户趋势没有具体意义。访问 user_vis收藏小程序 user_col订阅小程序消息 user_subs关注生活号 user_follow入商家群 user_group入会 user_mem支付 user_pay

{
    "index_key":"new_user_num",
    "request_params":{
        "end_date":"20220924",
        "start_date":"20220912",
        "relation_type":"user_subs",
        "dim":"day"
    }
}

查询支付占比趋势（index_key=pay_users_perc）

参数	说明
index_key	pay_users_perc
request_params	start_date	趋势图开始时间，如 20221212
end_date	趋势图结束时间，如 20221231
relation_type	不同用户关系类型，支付用户已排除。说明：支付用户的支付用户占比无意义。访问 user_vis互动 user_inter收藏小程序 user_col订阅小程序消息 user_subs关注生活号 user_follow入商家群 user_group入会 user_mem导入 user_import

{
    "index_key":"pay_users_perc",
    "request_params":{
        "start_date":"20221101",
        "end_date":"20221129",
        "relation_type":"user_vis"
    }
}

查询用户指标趋势（index_key=user_indications）

入参说明

参数	说明
index_key	user_indications
request_params	start_date	趋势图开始时间，如 20221212
end_date	趋势图结束时间，如 20221231
dim	时间维度，day 是自然日，week 是自然周。
user_key	可查看下文 userKey 参数及其对应的关系类型说明。

userKey 参数及其对应的关系类型说明

关系类型	数据表中入参	userKey
互动用户-收藏用户	当日收藏活跃用户	col_act
互动用户-订阅用户	订阅用户消息曝光日uv	subs_exp
订阅用户消息点击日uv	subs_ctr
互动用户-关注用户	关注用户中的活跃粉丝数	follow_act
互动用户-入群用户	入群用户中的活跃用户	group_act
会员	会员贡献率	mem_ctb
活跃会员数	mem_act
导入	当日活跃用户数	import_act

接口参数 Demo：

{
    "index_key":"user_indications",
    "request_params":{
        "end_date":"20221211",
        "start_date":"20221112",
        "user_key":"col_act",
        "dim":"week"
    }
}

行为分析不同 scene_code 查询

接口 alipay.merchant.qipan.behavior.query（行为分析）。

scene_code 参数含义总览

行为分析 scene_code	名称	对应模块
all_users_distribution	用户来源分布
vis_features	访问用户访问频次和时长
mem_features	会员近 30 天支付频次和客单
pay_user_features	支付用户支付频次、近 30 天客单和最近支付距今天数

查询用户来源分布（scene_code=all_users_distribution）

入参说明

参数 key	说明	示例&枚举
scene_code	场景码	all_users_distribution
request_params	relation_type	关系类型	访问 user_vis收藏小程序 user_col订阅小程序消息 user_subs关注生活号 user_follow入商家群 user_group入会 user_mem支付 user_pay互动和导入用户无来源分布指标
object_type	客体类型	all：全部（仅访问有全部）app：小程序（访问、收藏、支付）live_room：直播间（访问）life_pub：生活号（访问、关注）msg_temp：消息模板（订阅）group：群（入商家群）member_card：会员卡（入会）支付用户不用传该参数
report_date	数据日期，不填默认查昨日数据	20230105

{
    "scene_code":"all_users_distribution",
    "request_params":{
        "relation_type":"user_vis",
        "object_type":"app",
        "report_date":"20221203"
    }
}

查询访问用户 30 天内访问频次（次）和时长（天）（scene_code=vis_features）

入参说明

参数 key	说明	示例&枚举
sceneCode	场景码	vis_features
requestParams	feature	特征	访问天数（即访问频次）：frequency访问时长：duration
object_type	访问对象细分类型	访问生活号：life_pub访问直播间：live_room访问小程序：app（访问时长只有此参数）all（全部渠道，默认值）：all
object_id	生活号id、直播间id或者小程序id	如：2021003126612268、A202208290290754601000099、2021001136648264不传或者传all就是relationType下所有客体
report_date	数据日期，不填默认查昨日数据	20230105

{
    "scene_code":"vis_features",
    "request_params":{
        "object_type":"all",
        "object_id":"all",
        "feature":"frequency"
    }
}

查询会员用户 30 天内支付频次（次）和支付客单（元）（scene_code=mem_features）

入参说明：

参数 key	说明	示例&枚举
sceneCode	场景码	mem_features
requestParams	feature	必填	支付频次：frequency客单：amount
object_id	卡模板ID	传all就是所有会员卡
report_date	数据日期，不填默认查昨日数据	20230105

{
    "scene_code":"mem_features",
    "request_params":{
        "object_id":"20210****************499",
        "feature":"amount"
    }
}

查询支付用户 30 天内支付频次（次）、支付客单（元）和支付距今天数（天）（scene_code=pay_user_features）

入参说明

参数 key	说明	示例&枚举
scene_code	场景码	pay_user_features
request_params	feature	必填，查询特征	支付频次：frequency支付金额：amount最近支付距今天数：last_pay
object_type	支付关系细分类型	线下支付：offline小程序支付：appall（全部渠道，默认值）：all
object_id	小程序id	如：2021001136648264all（全部渠道，默认值）：all
report_date	数据日期，不填默认查询昨天数据	20230104

{
    "scene_code":"pay_user_features",
    "request_params":{
        "object_type":"app",
        "object_id":"all",
        "feature":"last_pay"
    }
}

返回参数说明：如果某区间没有用户，列表中就不返回对应的数据对象。

参考资料

安全应用范围枚举#

标签说明#

看板分析不同 scene_code 查询#

scene_code 参数含义总览#

查询资产总览和构成（scene_code=asset_overview）#

查询单日对应行为用户（scene_code=asset_type_num）#

查询人群用户概览（scene_code=crowd_overview）#

趋势分析不同 index_key 查询#

index_key参数含义总览#

查询总用户资产趋势（index_key=total_users）#

查询单日行为用户趋势（index_key=new_user_num）#

查询支付占比趋势（index_key=pay_users_perc）#

查询用户指标趋势（index_key=user_indications）#

userKey 参数及其对应的关系类型说明#

行为分析不同 scene_code 查询#

scene_code 参数含义总览#

查询用户来源分布（scene_code=all_users_distribution）#

查询访问用户 30 天内访问频次（次）和时长（天）（scene_code=vis_features）#

查询会员用户 30 天内支付频次（次）和支付客单（元）（scene_code=mem_features）#

查询支付用户 30 天内支付频次（次）、支付客单（元）和支付距今天数（天）（scene_code=pay_user_features）#

安全应用范围枚举

标签说明

看板分析不同 scene_code 查询

scene_code 参数含义总览

查询资产总览和构成（scene_code=asset_overview）

查询单日对应行为用户（scene_code=asset_type_num）

查询人群用户概览（scene_code=crowd_overview）

趋势分析不同 index_key 查询

index_key参数含义总览

查询总用户资产趋势（index_key=total_users）

查询单日行为用户趋势（index_key=new_user_num）

查询支付占比趋势（index_key=pay_users_perc）

查询用户指标趋势（index_key=user_indications）

userKey 参数及其对应的关系类型说明

行为分析不同 scene_code 查询

scene_code 参数含义总览

查询用户来源分布（scene_code=all_users_distribution）

查询访问用户 30 天内访问频次（次）和时长（天）（scene_code=vis_features）

查询会员用户 30 天内支付频次（次）和支付客单（元）（scene_code=mem_features）

查询支付用户 30 天内支付频次（次）、支付客单（元）和支付距今天数（天）（scene_code=pay_user_features）