画像分析

开发环境

POST

/v3/alipay/merchant/qipan/insight/query

棋盘画像分析（该接口不含常住省市的查询，常住省市查询见：alipay.merchant.qipan.insightcity.query接口）

错误码

公共错误码

业务错误码

状态码	错误码	错误描述	解决方案
400	ILLEGAL_ARGUMENT	参数非法	校验参数
400	SYSTEM_ERROR	系统繁忙	系统异常，稍后重试
400	ILLEGAL_PARAMS	参数错误	请根据接口文档修改参数
400	CROWD_NOT_EXIST	人群不存在	请更换人群id查询
400	CROWD_NOT_SUPPORT_INSIGHT	人群用户数量不足，不支持洞察	更换用户数量足够多的人群id
400	NO_ANALYSIS_DATA	分析数据未产出	更换日期参数（report_date）查询或者查询其他类型的数据
400	INSUFFICIENT_BUDGET	您今日查询画像次数过多，请明天再来。	明天再查询画像，否则只能查询今日查询过的画像内容。如果有更多的画像查询需求，请联系BD申请。
400	INVALID_PARAMS	参数错误	根据接口文档检查参数
400	CROWD_STATUS_NOT_SUPPORT_INSIGHT	人群未生效或者已失效，不支持洞察	人群查询，需要更换生效中的人群id

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/merchant/qipan/insight/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 '{
	"crowd_id":"test1",
	"relation_type":"user_subs",
	"portr_type_list":[
		"AGE",
		"GENDER"
	],
	"report_date":"20221230"
}'

响应示例

{
  "portrait_data_list": [
    {
      "portrait_key": "AGE",
      "portrait_name": "用户年龄段",
      "portrait_desc": "用户年龄段预测",
      "coverage": "0.7584",
      "report_date": "20220908",
      "data_list": [
        {
          "value": "未婚",
          "num": "10"
        }
      ]
    }
  ]
}

请求参数

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

crowd_id

string

可选

人群id，按人群分析时必传

relation_type

string

可选

用户关系类型，不传人群id时必传。如果人群id不为空，优先查询人群id对应的画像。枚举值访问: user_vis 收藏小程序: user_col 订阅消息: user_subs 关注生活号: user_follow 入商家群: user_group 入会: user_mem 支付: user_pay 导入: user_import

portr_type_list

array[string]

可选

商家按需选择传入的洞察维度，但该接口不包含常住省市的数据。如需查询常住省市，使用alipay.merchant.qipan.insightcity.query接口枚举值城市等级: CITY_LEVEL 预测婚姻状态: MARRIAGE 预测年龄段: AGE 预测性别: GENDER 预测职业: OCCUPATION 预测宝宝年龄段: CHILD_AGE 预测是否有车: HAS_CAR 预测是否有房: HAS_HOUSE 预测消费习惯: XFDC 预测兴趣偏好: WORDLIST_LV1 预测口味偏好（仅餐饮商户可见）: WORDLIST_CANYIN_LV4

report_date

string

可选

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

示例

返回响应

🟢200成功

application/json

Body

portrait_data_list

array [object {6}]

人群洞察分析数据

必需

portrait_key

string

可选

portrait_name

string

可选

portrait_desc

string

可选

coverage

string

可选

report_date

string

可选

data_list

array [object {2}]

可选

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

看板分析

行为分析

画像分析

错误码#

公共错误码#

业务错误码#

请求参数

返回响应

错误码

公共错误码

业务错误码