趋势分析

开发环境

POST

/v3/alipay/merchant/qipan/trend/query

查询棋盘趋势类型的数据，包含用户总资产变化趋势、用户资产新增趋势、支付用户占比变化趋势、用户其他行为指标的变化趋势。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/merchant/qipan/trend/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 '{
	"index_key":"new_user_num",
	"request_params":{
		"start_date":"20221012",
		"end_date":"20221212",
		"dim":"day",
		"exclude_import":true,
		"relation_type":"user_vis",
		"user_key":"col_act"
	}
}'

响应示例

{
  "index_trend_results": [
    {
      "index_key": "new_user_num",
      "index_name": "新增用户数",
      "index_desc": "各关系类型下的新增用户数",
      "index_value": "202",
      "report_date": "20220908",
      "start_date": "20220901",
      "end_date": "20220908"
    }
  ]
}

请求参数

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

index_key

string

必需

指标key，由棋盘注册，全局唯一，查询内容参考：趋势分析不同index_key查询枚举值新增用户关系趋势数据: new_user_num 各类用户占比指标趋势: user_indications 各类关系支付用户占比指标趋势: pay_users_perc

request_params

object

必需

趋势数据请求参数，如起止时间、关系类型、聚合维度等。

start_date

string

必需

趋势图开始时间，格式yyyyMMdd 注意事项不能晚于结束时间

end_date

string

必需

趋势图结束时间，格式yyyyMMdd 注意事项不能早于开始时间

dim

string

可选

时间维度的聚合会对用户去重。枚举值自然日: day 自然周（周一到周日）: week 自然月（每个月1号到最后一天）: month 注意事项如果选择week，返回自然周数据，如果结束时间非周日，则返回周一到最后一天的数据。如果选择month，返回自然月的数据，如果结束时间非月底，则返回当月1号到最后一天的数据。

exclude_import

boolean

可选

是否排除在棋盘导入的用户，导入方式包括文件上传和接口上传。只适用于总用户资产趋势的查询（index_key=total_users），设true则可查询访问、互动和支付用户的三大类总用户趋势。注意事项如果商户没有在棋盘导入过用户，该值对结果不产生影响。

relation_type

string

可选

用户资产关系类型，查询单日行为用户趋势（index_key=new_user_num）和查询支付占比趋势（index_key=pay_users_perc）时必填。枚举值访问: user_vis 收藏小程序: user_col 订阅消息: user_subs 关注生活号: user_follow 入商家群: user_group 入会: user_mem 支付: user_pay 导入: user_import 注意事项查询单日行为用户趋势时，不支持互动和导入用户的查询，因为互动用户是具体4类用户的总和（收藏、订阅、关注、入群），导入用户趋势没有具体意义。查询支付占比趋势时，不支持传支付类型，因为支付用户的支付用户占比无意义。

user_key

string

可选

用户指标趋势查询（index_key=user_indications）时必填。枚举值累计收藏当日活跃用户数: col_act 消息曝光量: subs_exp 消息点击量: subs_ctr 关注用户中的活跃粉丝数: follow_act 入群用户中的群活跃用户: group_act 会员贡献度: mem_ctb 活跃会员: mem_act 导入用户中的当日活跃用户数: import_act

示例

返回响应

🟢200成功

application/json

Body

index_trend_results

array [object {7}]

趋势分析数据

可选

index_key

string

可选

index_name

string

可选

index_desc

string

可选

index_value

string

可选

report_date

string

可选

start_date

string

可选

end_date

string

可选

修改于 2023-11-22 07:33:49

行为分析

常住省市查询