接口文档
1. 获取活动统计数据说明
接口会根据 JWT-TOKEN 中的 appid 和 appuid 查找对应24好玩平台用户创建的活动,返回活动参与用户数据。
2. 接口说明
请求域名
请求方式:GET 请求
请求头(Request Header)
content-type application/x-www-form-urlencoded 请求头content-type类型使用此类型
authorization 请求token,即JWT-TOKEN
请求参数说明
参数列表 | 参数说明 |
---|---|
gameId | 必选,游戏ID |
page | 可选,页码,默认第 1 页 |
pageSize | 可选,页面显示数据数量,默认每页 10 条 |
返回参数说明(Response Body)
参数列表 | 参数说明 |
---|---|
code | 返回状态码 |
msg | 状态说明信息 |
data | 请求成功数据。详细格式参见下方文档 |
/**
* @api {GET} /gameData/playerList 获取参与用户信息
* @apiHeader {String} token 请求token放入请求头authorization中,用 Bearer 类型
* @apiDescription 获取参与用户信息
* @apiName /gameData/playerList
* @apiGroup gameData
*
* @apiParam {Number} gameId 必选,游戏ID
* @apiParam {Number} page 可选,页码,默认第 1 页
* @apiParam {Number} pageSize 可选,页面显示数据数量,默认每页 10 条
*
* @apiSuccess {Number} code 接口状态码
* @apiSuccess {string} msg 返回信息
* @apiSuccessExample { json} Success-Response(0):
* {
* "code": 0,
* "msg": 'ok',
* "data": {
* "count": 1
* "userList": [
* {
* "city": "广州", // 用户城市
* "province": "广东", // 用户省份
* "headimgurl": "http://123cdd.png", // 玩家头像
* "name": "测试用户", // 用户名称
* "sex": "2", // 性别
* "share_from_users": "2", // 分享引流人数
* "share_times": "2", // 分享次数
* "times": "2", // 参与次数
* "view_times": "2", // 查看次数
* }
* ...
* }
* }
* }
* @apiErrorExample {json} Error-Response(7000):
* {
* "code": 7000,
* "msg": message // 服务器异常信息
* }
* @apiErrorExample {json} Error-Response(1001):
* {
* "code": 1001,
* "msg": "gameId error" // 参数错误,缺少gameId
* }
* @apiErrorExample {json} Error-Response(1002):
* {
* "code": 1002,
* "msg": "no game" // 参数错误,活动不存在
* }
* @apiErrorExample {json} Error-Response(1005):
* {
* "code": 1005,
* "msg": "page or pageSize error" // 参数错误
* }
* @apiErrorExample {json} Error-Response(9000):
* {
* "code": 9000,
* "msg": "token error" // token错误
* }
*/