Query Task Reward Activity Statistics Paginated List

Updated: 2024-07-18 09:28:45

API Description

1、查询任务奖励活动统计数据分页列表
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/channel/task-reward-activity/stats

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameters Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining the key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be stored or used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for responses.` See signature generation rules
channelId	true	Integer	Channel ID
pageSize	false	Integer	Page size (default 10, max 1000)
pageNumber	false	Integer	Page number (currently limited to a max of 1000 pages)

Example

https://api.polyv.net/live/v4/channel/task-reward-activity/stats?channelId=4854808&pageSize=10&pageNumber=1&appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

Response body JSON:

{
    "code": 200,
    "status": "success",
    "requestId": "e9eb12f0-5d55-482a-8a47-62863d04772c",
    "data": 10465,
    "success": true
}

Response Parameters Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result, determined by business logic: success returns "success", failure returns "error"
success	Boolean	Response result, determined by business logic: success returns true, failure returns false
data	Object	Task reward activity paginated data See Data field description
error	Object	Error information when status code is non-200 See Error field description
requestId	String	Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging; should not be tied to business logic

Data Parameter Description

Parameter	Type	Description
pageNumber	Integer	Page number
pageSize	String	Page size
totalPages	Boolean	Total number of pages
totalItems	Object	Total number of records
contents	Array	Activity data list See Contents field description

Contents Parameter Description

Parameter	Type	Description
channelId	Integer	Channel ID
activityId	Long	Activity ID
activityName	String	Activity name, max length 64 characters
taskRule	Integer	Task rule: 1: Unlock tasks, 2: Parallel tasks
startTime	Long	Activity start time
endTime	Long	Activity end time
participantTask	Integer	Number of participants in tasks
reachAllTask	Integer	Number of users who completed all tasks
reachAllReward	Integer	Number of users who claimed all rewards

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error cause
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of the base code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK to implement API functionality. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 删除任务奖励活动
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void statsTaskRewardTest() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());
        Integer channelId = 4962905;
        Integer pageSize = 10;
        Integer pageNumber = 1;
        //业务参数
        String url = "https://api.polyv.net/live/v4/channel/task-reward-activity/stats";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("channelId", channelId);
        requestMap.put("pageSize", pageSize);
        requestMap.put("pageNumber", pageNumber);
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("测试任务奖励活动分页查询成功：{}", response);
        //do somethings
}

Response Example

For system-wide error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "d018fd435ed4468c81592182f652fefb.66.17212083349786049",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 3,
        "contents": [
            {
                "activityId": 36,
                "userId": "2b3ccac944",
                "channelId": 4962905,
                "activityName": "测试任务",
                "activityMode": 1,
                "taskRule": 1,
                "status": 0,
                "startTime": 1719829080000,
                "endTime": 1719829663000,
                "participantTask": 7,
                "reachAllTask": 7,
                "reachAllReward": 7
            }
        ]
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}