行为分析

开发环境

POST

/v3/alipay/merchant/qipan/behavior/query

棋盘开放行为分析接口，可查询内容包含用户来源分布数据，访问用户30天内访问频次（次）和时长（天），会员用户30天内支付频次（次）和支付客单（元），以及支付用户30天内支付频次（次）、支付客单（元）和支付距今天数（天）

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/merchant/qipan/behavior/query' \
--header 'authorization: ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign' \
--header 'alipay-request-id: $requestid' \
--header 'Content-Type: application/json' \
--data-raw '{
	"scene_code":"all_users_distribution",
	"request_params":{
		"relation_type":"user_vis",
		"object_type":"app",
		"object_id":"202xxxxxxxxxx2268",
		"feature":"frequency",
		"report_date":"20230109"
	}
}'

响应示例

{
  "multi_data_list": [
    {
      "object_type": "all",
      "object_id": "test1",
      "object_name": "小谷二手书",
      "feature_key": "5-30秒",
      "user_cnt": "15",
      "user_ratio": "0.108696",
      "avg_num": "104.48255272487617"
    }
  ]
}

请求参数

Header 参数

authorization

string

必需

示例值:

ALIPAY-SHA256withRSA app_id=$appid,timestamp=$now,nonce=$uuid,expired_seconds=600,sign=$sign

alipay-request-id

string

必需

示例值:

$requestid

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

scene_code

string

必需

查询场景，由棋盘注册，全局唯一。如：会员客单价区间、支付频次等。参考：行为分析不同scene_code查询内容枚举值用户来源分布: all_users_distribution 访问用户访问频次和时长: vis_features 会员支付频次和客单: mem_features 支付用户支付频次、客单和最近一次支付距今天数: pay_user_features （会员用户）30天内支付客单（元）: mem_paid_amount

request_params

object

必需

行为分析查询，不同查询场景的查询参数，如关系类型、关系对象类型等。

relation_type

string

可选

用户资产关系类型，查询用户来源分布（scene_code=all_users_distribution）时必填。枚举值访问: user_vis 收藏小程序: user_col 订阅消息: user_subs 关注生活号: user_follow 入商家群: user_group 入会: user_mem 支付: user_pay 注意事项互动和导入用户无来源分布指标。

object_type

string

可选

关系对象主体类型，即资产关系是建立在什么对象上的。查询用户来源分布（scene_code=all_users_distribution）、查询访问用户 30 天内访问频次（次）和时长（天）（scene_code=vis_features）、查询支付用户 30 天内支付频次（次）、支付客单（元）和支付距今天数（天）（scene_code=pay_user_features）时必填。枚举值全部: all 小程序（访问、收藏、支付）: app 直播间（访问）: live_room 生活号（访问、关注）: life_pub 消息模板（订阅）: msg_temp 入商家群: group 会员卡（入会）: member_card 线下（支付）: offline 注意事项 scene_code=all_users_distribution时，所有枚举都可用。 scene_code=vis_features时，可传all、app、life_pub、live_room。 scene_code=pay_user_features时，可传all、app、offline。

object_id

string

可选

关系对象主体类型id，即资产关系是建立在什么对象id上的，如小程序appid、生活号id、直播间id、卡模板id等。注意事项线下支付无object_id。

feature

string

可选

查询访问用户 30 天内访问频次（次）和时长（天）（scene_code=vis_features）、查询会员用户 30 天内支付频次（次）和支付客单（元）（scene_code=mem_features）、以及查询支付用户 30 天内支付频次（次）、支付客单（元）和支付距今天数（天）（scene_code=pay_user_features）时必填。枚举值访问天数、支付频次: frequency 访问时长: duration 支付金额: amount 最近支付距今天数: last_pay

report_date

string

可选

数据日期，格式yyyyMMdd。注意事项 reportDate可不传，不传查询最新的数据。但是如果有值，必须不大于昨天的日期，比如今天是2023年1月11日，则传不大于2023110的值，否则会报错参数异常。

示例

返回响应

🟢200成功

application/json

Body

multi_data_list

array [object {7}]

人群行为分析数据

可选

object_type

string

可选

object_id

string

可选

object_name

string

可选

feature_key

string

可选

user_cnt

string

可选

user_ratio

string

可选

avg_num

string

可选

修改于 2023-11-22 07:31:32

画像分析

趋势分析