获取活动用户列表
调用方式
- 请求方式:
POST - 请求地址:
https://tls2s.allapp.link/manage/campaign/user_list?project_id=你的ProjectId
请求头参数(Header)
| 参数 | 必须 | 值 | 说明 |
|---|---|---|---|
| Content-Type | 是 | application/json | 声明json格式 |
| Authorization | 是 | Bearer md5(OpenSecret+(空格)+md5(请求body)) | OpenSecret 获取方式:Dashboard > 开发配置 > 开放平台秘钥 获取OpenSecret |
请求内容参数(Body)
请求示例:
{
"page": 1,
"page_size": 1000,
"campaign_id": "cvbvl1urdjknm77a1dj0",
"last_record_id": "3098475647382933482"
}参数说明
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| project_id | 是 | string | 项目id |
| page | 否 | number | 第几页(最小填 1) |
| page_size | 否 | number | 每页数量(不超过 1,000) |
| campaign_id | 是 | string | 活动id |
| last_record_id | 否 | string | 拉取的最后一条数据的id (首次页数据穿空字符串,提交该字段,返回当前id往后的数据,但不包括当前id的数据,有该值时,请不要和page一起使用) |
返回示例
{
"code": 200,
"msg": "请求成功",
"data": {
"list": [
{
"user_id": "user_id",
"device_id": "device_id",
"parent_user_id": "parent_user_id",
"join_at": 1729492992,
"direct_invite_num": 1,
"indirect_invite_num": 1,
"effect_num": 1,
"record_id": "3098475647382933482",
"source_title": "安装事件",
"os": "ios",
"channel_title": "默认渠道",
"first_visit_time": 1729492992
},
{
"user_id": "user_id",
"device_id": "device_id",
"parent_user_id": "",
"join_at": 1729492992,
"direct_invite_num": 1,
"indirect_invite_num": 1,
"effect_num": 1,
"record_id": "3098475647382933483",
"source_title": "自定义事件",
"os": "android",
"channel_title": "默认渠道",
"first_visit_time": 1729492992
}
],
"total": 10,
"lave": 10,
}
}返回参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int32 | 返回状态码 200为成功返回 |
| msg | string | 返回状态码信息 |
| data | object | 返回内容 |
| data.total | number | 活动用户总数(last_record_id有值时,当前字段为0) |
| data.lave | number | 剩余未拉取数据条数,当前last_record_id后剩余的数据条数 |
| data.list | array(object) | 活动用户列表 |
| data.list.user_id | string | 活动用户id |
| data.list.device_id | string | 活动用户设备id |
| data.list.parent_user_id | string | 上级用户id |
| data.list.join_at | number | 活动参与时间差(单位:秒) |
| data.list.direct_invite_num | number | 直接邀请人数 |
| data.list.indirect_invite_num | number | 间接邀请人数 |
| data.list.effect_num | number | 有效邀请人数 |
| data.list.record_id | number | 记录ID |
| data.list.source_title | string | 参与方式 |
| data.list.os | string | 操作系统 |
| data.list.channel_title | string | 渠道 |
| data.list.first_visit_time | number | 首次访问时间 |
Tips: 建议使用”last_record_id”来拉取用户数据,每次拉取数据后,提供当前拉取的最后一条数据的record_id即可拉取下一页数据,当lave为0时,表示可以停止拉取