Appearance
获取用户消费信息
| 拥有此API的权限集 |
|---|
| 用户管理-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.user.list/1.0.0 - 频率限制：
10秒3000次
接口调试
请求参数
响应结果
暂无响应数据
请求参数
| 参数名 | 必选 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|---|
| access_token | 是 | string | 专属token | ... |
| page_size | 否 | int | 每页记录数 | ... |
| key_word | 否 | string | 关键字 | ... |
| key_word_batch | 否 | array | 批量关键字 | ... |
| key_word_type | 否 | int | 关键字类型 | 1-手机号（包括采集手机号）；2-昵称；3-真实姓名 |
| tag_id | 否 | string | 标签id | 多个标签使用 ','拼接 |
| user_from | 否 | int | 来源 | 0-全部；1-微信；2-抖音小程序；，往后推 |
| user_identity | 否 | int | 用户身份 | 0-全部；1-黑名单；2-超级会员 |
| pay_time_start | 否 | date | 最近消费时间（开始） | 格式：yyyy-mm-dd |
| pay_time_end | 否 | date | 最近消费时间（结束） | 格式：yyyy-mm-dd |
| pay_money_min | 否 | int | 累计消费金额（分）（最低） | ... |
| pay_money_max | 否 | int | 累计消费金额（分）（最高） | ... |
| buy_times_min | 否 | int | 购买次数（最少） | ... |
| buy_times_max | 否 | int | 购买次数（最多） | ... |
| user_created_start | 否 | date | 用户创建时间（开始）yyyy-mm-dd | ... |
| user_created_end | 否 | date | 用户创建时间（结束）yyyy-mm-dd | ... |
| latest_visited_start | 否 | date | 用户最后访问时间（开始）yyyy-mm-dd | ... |
| latest_visited_end | 否 | date | 用户最后访问时间（结束）yyyy-mm-dd | ... |
| birth_start | 否 | object | 生日时间（开始）{"month":"01","day":"01"} | ... |
| birth_end | 否 | object | 生日时间（结束）{"month":"01","day":"01"} | ... |
| job | 否 | string | 职位 | ... |
| industry | 否 | string | 行业 | ... |
| company | 否 | string | 公司 | ... |
| wx_gender | 否 | int | 性别 | 1-全部 0-无 1-男 2-女 |
| company | 否 | string | 公司 | ... |
| user_state | 否 | int | 用户状态 | -2 全部 -1-注销 0-正常 |
| age_start | 否 | int | 年龄（开始） | ... |
| age_end | 否 | int | 年龄（结束） | ... |
| user_crowd | 否 | array | 人群 | ... |
| or_conditions | 否 | object | or 条件 里面的条件字段与and条件字段一样 | ... |
| es_skip | 否 | string | 上一页最后一条数据中的es_skip字段转成的字符串,不传则为第一页，用于翻页 | ... |
请求示例
{
"access_token": "xxxxxxxx",
"page_size": 100,
"es_skip": "{\"user_created_at\":1596038400000,\"id\":\"u_58bf6524201aa_2cAqUNFl\"}"
}返回参数说明
| 参数名 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|
| code | int | 错误码 | 0 |
| msg | string | 错误描述 | ok |
| data | Object | 返回值 | ... |
| data.user_list | array | 用户列表 | ... |
| data.total | int | 用户总数 | ... |
用户列表 user_list
| 参数名 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|
| es_skip | array | 创建信息 | ... |
| user_id | string | 用户id | ... |
| auto_tags | array | 自动标签 | ["7642"] |
| app_id | string | 店铺id | .... |
| manual_tags | array | 自动标签 | [".."] |
| bought_products | array | 购买商品记录 | ... |
| pay_money | int | 消费总金额（分） | 1000 |
| buy_times | int | 购买次数 | ... |
| first_pay_time | int | 首次支付时间 | 单位：毫秒 0-代表没有 |
| lastest_pay_time | int | 最后购买时间 | ... |
| nick_name | string | 昵称 | ... |
| svip_id | string | 超级会员id | ... |
| svip_identity_type | int | 超级会员类型 | ... |
| svip_start_time | long | 超级会员开始时间 | 时间戳 -1-没有 |
| svip_end_time | long | 超级会员结束时间 | 时间戳 -1-没有 |
| collection_phone | string | 采集手机号 | ... |
| phone | string | 手机号 | ... |
| user_created_at | string | 用户创建时间 | ... |
| user_from | string | 用户来源：0-微信、1-sdk、2-字节跳动、3-百度、4-飞书企业内训、5-小班课app、6-通用h5、7-微博、8-B端导入、9-手机号注册、10-QQ、11-视频号、12-快手、13-小红书、14-apple、15-品牌app、16-crm、17-视频号小店、18-小鹅通小店、19-抖音广告投放、20-鹅合伙、21-鹅市场、22-直播助教/讲师 | ... |
购买商品记录 bought_products
| 参数名 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|
| pid | string | 商品id | ... |
| oid | string | 订单id | ... |
| app_type | int | 0-小程序、1-公众号、10-开放平台、11-PC通用版、12-App | |
| os | int | 订单状态 | 0-未支付，1-支付成功，3-已退款(如拼团未成功等情况)，6-订单超时未支付，自动取消，7-手动取消，8-退款中，9-退款失败，10-退款成功，11-部分退款 |
| pay_type | int | 支付类型 | 2-单笔，3-订阅付费产品包，4-团购，5-单笔的购买赠送，6-订阅付费产品包的购买赠送，7-问答提问，8-问答偷听，9-购买会员，10-会员的购买赠送，11-活动付费报名，12-打赏，13-单笔的拼团，14-订阅付费产品包的拼团，15-超级会员，16-接入商兑换码 |
| price | int | 商品价格 | 单位：分 |
| tm | int | 商品购买时间，单位：毫秒 | ... |
创建信息 es_skip
| 参数名 | 类型 | 说明 | 备注（示例） |
|---|---|---|---|
| user_created_at | string | 用户创建时间 | ... |
| id | string | 用户id | ... |
返回示例
{
"code": 0,
"msg": "成功",
"data": {
"total": 406638,
"user_list": [
{
"app_id": "appAKLWLitn7978",
"auto_tags": [
"57626"
],
"bought_products": [
{
"app_type": 1,
"oid": "o_1629497408_61202840d50ea_76979479",
"os": 1,
"pay_type": 15,
"pid": "s_5be2ddff0bf70_fLY84boB",
"price": 0,
"tm": 1629497409000
}
],
"buy_times": 1,
"collection_phone": "",
"es_skip": {
"id": "u_xbk_5f218fadcbd06_E9ThOcfrdD",
"user_created_at": 1596034989000
},
"first_pay_time": 1629497409000,
"lastest_pay_time": 1629497408000,
"manual_tags": [
"45234"
],
"nick_name": "我不要",
"pay_money": 0,
"svip_end_time": -1,
"svip_id": "",
"svip_identity_type": -1,
"svip_start_time": -1,
"phone": "",
"user_created_at": 1596034989000,
"user_from": 5,
"user_id": "u_xbk_5f218fadcbd06_E9ThOcfrdD"
}
]
}
}