登录峰值报表

请求地址： POST /reports/sn/peak
接口概述：

批量获取授权码在指定时间范围内的每月（或每日）登录峰值报表。
请求参数：

无

请求体：

参数名	参数类型	参数说明	必需	备注
sns	array	授权码列表	是	授权码列表，长度不能超过10。由string类型组成的数组。
startDate	string	起始日期	是	`yyyy-MM-dd HH:mm:ss`
endDate	string	结束日期	否	不传默认当天的`yyyy-MM-dd 23:59:59`，时间范围不能超过6个月
scale	string	查询单位	否	单位：month：月，day：日，默认month

请求示例：

POST /bitanswer/api/reports/sn/peak HTTP/1.1
Host: back-office-api.bitanswer.cn
Content-Type: application/json
bitkey: ••••••

{
   "sns": [
       "xxxxx1",
       "xxxxx2"
   ],
   "startDate":"2024-03-01",
   "scale": "day"
}

响应示例：

{
   "status": 0,
   "data": {
       "total": 7,
       "items": [
           {
               "sn": "xxxxx1",
               "unit": "day",
               "date": "2024-03-01 00:00:00",
               "peak": 23
           },
           {
               "sn": "xxxxx1",
               "unit": "day",
               "date": "2024-03-02 00:00:00",
               "peak": 19
           },
           {
               "sn": "xxxxx1",
               "unit": "day",
               "date": "2024-03-03 00:00:00",
               "peak": 13
           },
           {
               "sn": "xxxxx2",
               "unit": "day",
               "date": "2024-03-01 00:00:00",
               "peak": 12
           },
           {
               "sn": "xxxxx2",
               "unit": "day",
               "date": "2024-03-02 00:00:00",
               "peak": 2
           },
           {
               "sn": "xxxxx2",
               "unit": "day",
               "date": "2024-03-03 00:00:00",
               "peak": 23
           }
       ]
   }
}

响应体说明

用户使用时长报表

请求地址： POST /reports/users/usage
接口概述：

获取（批量）授权码绑定的（批量）用户在指定时间范围内使用的分钟数。
请求参数：

无

请求体：

参数名	参数类型	参数说明	必需	备注
sns	array	授权码列表	是	授权码列表，长度不能超过10。由string类型组成的数组。不传则返回空响应。
users	array	用户列表	是	用户列表，长度不能超过10。不传则返回空响应。用户object见下方`user`说明。
startDate	string	起始日期	是	`yyyy-MM-dd HH:mm:ss`
endDate	string	结束日期	否	不传默认当天的`yyyy-MM-dd 23:59:59`，时间范围不能超过6个月

user

参数名	参数类型	参数说明	必需	备注
loginName	string	帐号	否	loginName、email、phone至少存在一个，按顺序生效。
email	string	邮箱	否
phone	string	手机号	否

请求示例：

POST /bitanswer/api/reports/users/usage HTTP/1.1
Host: back-office-api.bitanswer.cn
Content-Type: application/json
bitkey: ••••••

{
   "sns": [
       "xxxxx1"
   ],
   "users":[
       {"loginName": "login_name"}
   ],
   "startDate":"2023-08-01",
   "endDate":"2024-02-01"
}

响应示例：

{
   "status": 0,
   "data": {
       "total": 1,
       "items": [
           {
               "sn": "xxxxx1",
               "user": {
                   "loginName": "login_Name",
                   "email":"email@123.com",
                   "phone":"12345678901"
               },
               "durationMinutes": 11373
           }
       ]
   }
}

响应体说明

用户使用错误报表

请求地址： POST /reports/users/errors
接口概述：

获取（批量）授权码绑定的（批量）用户在指定时间范围内使用返回的错误码总数。
请求参数：

无

请求体：

参数名	参数类型	参数说明	必需	备注
sns	array	授权码列表	是	授权码列表，长度不能超过10。由string类型组成的数组。不传则返回空响应。
user	array	用户列表	是	用户列表，长度不能超过10。不传则返回空响应。用户object见下方`user`说明。
startDate	string	起始日期	是	`yyyy-MM-dd HH:mm:ss`
endDate	string	结束日期	否	不传默认当天的`yyyy-MM-dd 23:59:59`，时间范围不能超过6个月
errorCodes	array	错误码列表	否	错误码列表。由integer组成的数组。不传则查全部。

user

参数名	参数类型	参数说明	必需	备注
loginName	string	帐号	否	loginName、email、phone至少存在一个，按顺序生效。
email	string	邮箱	否
phone	string	手机号	否

请求示例：

POST /bitanswer/api/reports/users/errors HTTP/1.1
Host: back-office-api.bitanswer.cn
Content-Type: application/json
bitkey: ••••••

{
   "sns": [
       "xxxxx1"
   ],
   "users":[
       {"loginName": "login_name"}
   ],
   "errorCodes":[
       1978,
       1798
   ],
   "startDate":"2023-08-01",
   "endDate":"2024-02-01"
}

响应示例：

{
   "status": 0,
   "data": {
       "total": 1,
       "items": [
           {
               "sn": "xxxxx1",
               "user": {
                   "loginName": "login_name"
               },
               "errorInfos": [
                   {
                       "code": 1978,
                       "count": 6
                   },
                   {
                       "code": 1798,
                       "count": 2
                   }
               ]
           }
       ]
   }
}

响应体说明