接口说明

使用 HTTPS 请求头 Authorization: Bearer $AppKey
此 API 需要 AppKey

调用方式

对接口传参

参数解释

请求包体:

{
    "project_id": "branch-proj-01",
    "start_time": 1711296000,
    "end_time": 1711382399,
    "page": 1, 
    "page_size": 1000
}

参数说明:

参数必须类型说明
project_idstring项目 ID
start_timenumber开始时间(s)
end_timenumber结束时间(s)
pagenumber第几页(最小填 1)
page_sizenumber每页数量(不超过 1,000)

返回结果

{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "list": [
            {
                "user_id": "2c8b85105145bdeeb9e0984ce7e87839",
                "campaign_title": "活动标题",
                "campaign_id": "活动ID",
                "effect_num": 0,
                "is_new": 0,
                "help_status": 0,
            },
            {
                "user_id": "698186985ad16530aeacde81f29a2e2d",
                "campaign_title": "活动标题",
                "campaign_id": "活动ID",
                "effect_num": 2,
                "is_new": 1,
                "help_status": 1,
            },
            {
                "user_id": "aa6e731d6c415ea7e27b2ac03c2bb4a6",
                "campaign_title": "活动标题",
                "campaign_id": "活动ID",
                "effect_num": 4,
                "is_new": 0,
                "help_status": 2,
            }
        ],
        "total": 10,
        "all_total": 885
    }
}

参数说明:

参数类型说明
codeint32操作结果代码, 200 - 成功
msgstringcode 非 200 时为错误信息
dataobject用户列表数据
data.listarray(object)用户列表
data.list.user_idstringAPP 用户 ID
data.list.campaign_titlestring活动标题
data.list.campaign_idstring活动ID
data.list.effect_numnumber有效邀请人数
data.list.is_newnumber是否新用户(0-否,1-是)
data.list.help_statusnumber助力状态(0-无法助力,1-助力成功,2-助力失败)
data.totalstring此次返回的用户数
data.all_totalnumber总用户数

help_status说明:无法助力-没有上级用户id的用户, 助力成功-完成后台配置的助力条件即可成功(会从失败切到成功),助力失败-还没完成助力条件或不符合助力条件