开放平台Re-Boost获取活动用户列表

获取活动用户列表

调用方式

  • 请求方式: POST
  • 请求地址: https://tls2s.allapp.link/manage/campaign/user_list?project_id=你的ProjectId

请求头参数(Header)

参数必须说明
Content-Typeapplication/json声明json格式
AuthorizationBearer md5(OpenSecret+(空格)+md5(请求body))OpenSecret 获取方式:Dashboard > 开发配置 > 开放平台秘钥 获取OpenSecret

请求内容参数(Body)

请求示例:

{
    "page": 1,
    "page_size": 1000,
    "campaign_id": "cvbvl1urdjknm77a1dj0",
    "last_record_id": "3098475647382933482"
}

参数说明

参数必须类型说明
project_idstring项目id
pagenumber第几页(最小填 1)
page_sizenumber每页数量(不超过 1,000)
campaign_idstring活动id
last_record_idstring拉取的最后一条数据的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,
    }
}

返回参数说明

参数类型说明
codeint32返回状态码 200为成功返回
msgstring返回状态码信息
dataobject返回内容
data.totalnumber活动用户总数(last_record_id有值时,当前字段为0)
data.lavenumber剩余未拉取数据条数,当前last_record_id后剩余的数据条数
data.listarray(object)活动用户列表
data.list.user_idstring活动用户id
data.list.device_idstring活动用户设备id
data.list.parent_user_idstring上级用户id
data.list.join_atnumber活动参与时间差(单位:秒)
data.list.direct_invite_numnumber直接邀请人数
data.list.indirect_invite_numnumber间接邀请人数
data.list.effect_numnumber有效邀请人数
data.list.record_idnumber记录ID
data.list.source_titlestring参与方式
data.list.osstring操作系统
data.list.channel_titlestring渠道
data.list.first_visit_timenumber首次访问时间

Tips: 建议使用”last_record_id”来拉取用户数据,每次拉取数据后,提供当前拉取的最后一条数据的record_id即可拉取下一页数据,当lave为0时,表示可以停止拉取