@rebornteam/reborn-api 4.9.1 → 4.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +10 -0
- package/README.md +21 -2
- package/api.ts +884 -45
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +475 -1
- package/dist/api.js +615 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +475 -1
- package/dist/esm/api.js +615 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AdminDashboardActivityCell.md +25 -0
- package/docs/AdminDashboardApi.md +453 -0
- package/docs/AdminDashboardCategoryCount.md +23 -0
- package/docs/AdminDashboardCountryCount.md +25 -0
- package/docs/AdminDashboardDailySessions.md +27 -0
- package/docs/AdminDashboardModeratorActivity.md +23 -0
- package/docs/AdminDashboardOverview.md +35 -0
- package/docs/AdminDashboardPunishmentDaily.md +25 -0
- package/docs/AdminDashboardReportSummary.md +27 -0
- package/docs/AdminDashboardServerRegion.md +27 -0
- package/docs/AdminDashboardTrustBucket.md +23 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 4.9.
|
|
7
|
+
* The version of the OpenAPI document: 4.9.2
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 4.9.
|
|
7
|
+
* The version of the OpenAPI document: 4.9.2
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Reborn API
|
|
4
4
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 4.9.
|
|
6
|
+
* The version of the OpenAPI document: 4.9.2
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Reborn API
|
|
5
5
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 4.9.
|
|
7
|
+
* The version of the OpenAPI document: 4.9.2
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Reborn API
|
|
3
3
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.9.
|
|
5
|
+
* The version of the OpenAPI document: 4.9.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Reborn API
|
|
6
6
|
* The Reborn API serves as the central backend for the platform, orchestrating secure communication between game clients and data services. This API supports two authentication methods: - **OAuth 2.0 Client Credentials**: For programmatic API access - **Discord SSO Bearer Token**: For admin endpoints requiring Discord authentication
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 4.9.
|
|
8
|
+
* The version of the OpenAPI document: 4.9.2
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AdminDashboardActivityCell
|
|
2
|
+
|
|
3
|
+
One cell of the activity heatmap: connection volume bucketed by UTC day-of-week (0 = Sunday) and hour-of-day (0--23).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**dayOfWeek** | **number** | UTC day of week, 0 = Sunday … 6 = Saturday | [default to undefined]
|
|
10
|
+
**hourOfDay** | **number** | UTC hour of day, 0–23 | [default to undefined]
|
|
11
|
+
**count** | **number** | Connections in this bucket | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminDashboardActivityCell } from '@rebornteam/reborn-api';
|
|
17
|
+
|
|
18
|
+
const instance: AdminDashboardActivityCell = {
|
|
19
|
+
dayOfWeek,
|
|
20
|
+
hourOfDay,
|
|
21
|
+
count,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -4,7 +4,172 @@ All URIs are relative to *https://api.smsh.sh*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**activityHeatmap**](#activityheatmap) | **GET** /admin/dashboard/connections/activity | Connection activity heatmap|
|
|
8
|
+
|[**connectionsByCountry**](#connectionsbycountry) | **GET** /admin/dashboard/connections/countries | Connections by country|
|
|
9
|
+
|[**dailySessions**](#dailysessions) | **GET** /admin/dashboard/sessions/daily | Daily session activity|
|
|
7
10
|
|[**dashboardStats**](#dashboardstats) | **GET** /admin/dashboard | Get dashboard statistics|
|
|
11
|
+
|[**overview**](#overview) | **GET** /admin/dashboard/overview | Dashboard overview tiles|
|
|
12
|
+
|[**punishmentsByType**](#punishmentsbytype) | **GET** /admin/dashboard/punishments/daily | Punishments by type over time|
|
|
13
|
+
|[**reportSummary**](#reportsummary) | **GET** /admin/dashboard/reports/summary | Report backlog & resolution speed|
|
|
14
|
+
|[**serverRegions**](#serverregions) | **GET** /admin/dashboard/servers/summary | Servers & players by region|
|
|
15
|
+
|[**topModerators**](#topmoderators) | **GET** /admin/dashboard/moderators/top | Top moderators by activity|
|
|
16
|
+
|[**trustDistribution**](#trustdistribution) | **GET** /admin/dashboard/trust/distribution | Trust-factor distribution|
|
|
17
|
+
|
|
18
|
+
# **activityHeatmap**
|
|
19
|
+
> Array<AdminDashboardActivityCell> activityHeatmap()
|
|
20
|
+
|
|
21
|
+
Connection volume bucketed by UTC day-of-week (0=Sunday) and hour-of-day (0–23) over the window.
|
|
22
|
+
|
|
23
|
+
### Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import {
|
|
27
|
+
AdminDashboardApi,
|
|
28
|
+
Configuration
|
|
29
|
+
} from '@rebornteam/reborn-api';
|
|
30
|
+
|
|
31
|
+
const configuration = new Configuration();
|
|
32
|
+
const apiInstance = new AdminDashboardApi(configuration);
|
|
33
|
+
|
|
34
|
+
let days: number; //Trailing window in days (optional) (default to 30)
|
|
35
|
+
|
|
36
|
+
const { status, data } = await apiInstance.activityHeatmap(
|
|
37
|
+
days
|
|
38
|
+
);
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Parameters
|
|
42
|
+
|
|
43
|
+
|Name | Type | Description | Notes|
|
|
44
|
+
|------------- | ------------- | ------------- | -------------|
|
|
45
|
+
| **days** | [**number**] | Trailing window in days | (optional) defaults to 30|
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
**Array<AdminDashboardActivityCell>**
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: Not defined
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### HTTP response details
|
|
63
|
+
| Status code | Description | Response headers |
|
|
64
|
+
|-------------|-------------|------------------|
|
|
65
|
+
|**200** | Hour-of-day × day-of-week activity cells | - |
|
|
66
|
+
|
|
67
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
68
|
+
|
|
69
|
+
# **connectionsByCountry**
|
|
70
|
+
> Array<AdminDashboardCountryCount> connectionsByCountry()
|
|
71
|
+
|
|
72
|
+
Top countries by distinct connection volume over the window, with the VPN/proxy-flagged subset.
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
AdminDashboardApi,
|
|
79
|
+
Configuration
|
|
80
|
+
} from '@rebornteam/reborn-api';
|
|
81
|
+
|
|
82
|
+
const configuration = new Configuration();
|
|
83
|
+
const apiInstance = new AdminDashboardApi(configuration);
|
|
84
|
+
|
|
85
|
+
let days: number; //Trailing window in days (optional) (default to 30)
|
|
86
|
+
let limit: number; //Max countries to return (optional) (default to 15)
|
|
87
|
+
|
|
88
|
+
const { status, data } = await apiInstance.connectionsByCountry(
|
|
89
|
+
days,
|
|
90
|
+
limit
|
|
91
|
+
);
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
|Name | Type | Description | Notes|
|
|
97
|
+
|------------- | ------------- | ------------- | -------------|
|
|
98
|
+
| **days** | [**number**] | Trailing window in days | (optional) defaults to 30|
|
|
99
|
+
| **limit** | [**number**] | Max countries to return | (optional) defaults to 15|
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
### Return type
|
|
103
|
+
|
|
104
|
+
**Array<AdminDashboardCountryCount>**
|
|
105
|
+
|
|
106
|
+
### Authorization
|
|
107
|
+
|
|
108
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
109
|
+
|
|
110
|
+
### HTTP request headers
|
|
111
|
+
|
|
112
|
+
- **Content-Type**: Not defined
|
|
113
|
+
- **Accept**: application/json
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
### HTTP response details
|
|
117
|
+
| Status code | Description | Response headers |
|
|
118
|
+
|-------------|-------------|------------------|
|
|
119
|
+
|**200** | Country breakdown | - |
|
|
120
|
+
|
|
121
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
122
|
+
|
|
123
|
+
# **dailySessions**
|
|
124
|
+
> Array<AdminDashboardDailySessions> dailySessions()
|
|
125
|
+
|
|
126
|
+
Per-day session count, distinct active players, and mean completed-session length over the requested window.
|
|
127
|
+
|
|
128
|
+
### Example
|
|
129
|
+
|
|
130
|
+
```typescript
|
|
131
|
+
import {
|
|
132
|
+
AdminDashboardApi,
|
|
133
|
+
Configuration
|
|
134
|
+
} from '@rebornteam/reborn-api';
|
|
135
|
+
|
|
136
|
+
const configuration = new Configuration();
|
|
137
|
+
const apiInstance = new AdminDashboardApi(configuration);
|
|
138
|
+
|
|
139
|
+
let days: number; //Trailing window in days (optional) (default to 30)
|
|
140
|
+
|
|
141
|
+
const { status, data } = await apiInstance.dailySessions(
|
|
142
|
+
days
|
|
143
|
+
);
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Parameters
|
|
147
|
+
|
|
148
|
+
|Name | Type | Description | Notes|
|
|
149
|
+
|------------- | ------------- | ------------- | -------------|
|
|
150
|
+
| **days** | [**number**] | Trailing window in days | (optional) defaults to 30|
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
### Return type
|
|
154
|
+
|
|
155
|
+
**Array<AdminDashboardDailySessions>**
|
|
156
|
+
|
|
157
|
+
### Authorization
|
|
158
|
+
|
|
159
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
160
|
+
|
|
161
|
+
### HTTP request headers
|
|
162
|
+
|
|
163
|
+
- **Content-Type**: Not defined
|
|
164
|
+
- **Accept**: application/json
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
### HTTP response details
|
|
168
|
+
| Status code | Description | Response headers |
|
|
169
|
+
|-------------|-------------|------------------|
|
|
170
|
+
|**200** | Daily session timeseries | - |
|
|
171
|
+
|
|
172
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
8
173
|
|
|
9
174
|
# **dashboardStats**
|
|
10
175
|
> AdminGetDashboardStats dashboardStats()
|
|
@@ -52,3 +217,291 @@ This endpoint does not have any parameters.
|
|
|
52
217
|
|
|
53
218
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
54
219
|
|
|
220
|
+
# **overview**
|
|
221
|
+
> AdminDashboardOverview overview()
|
|
222
|
+
|
|
223
|
+
At-a-glance counts: players online now, new players today, DAU, 7-day mean/median session length, active bans/mutes, and open reports.
|
|
224
|
+
|
|
225
|
+
### Example
|
|
226
|
+
|
|
227
|
+
```typescript
|
|
228
|
+
import {
|
|
229
|
+
AdminDashboardApi,
|
|
230
|
+
Configuration
|
|
231
|
+
} from '@rebornteam/reborn-api';
|
|
232
|
+
|
|
233
|
+
const configuration = new Configuration();
|
|
234
|
+
const apiInstance = new AdminDashboardApi(configuration);
|
|
235
|
+
|
|
236
|
+
const { status, data } = await apiInstance.overview();
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
### Parameters
|
|
240
|
+
This endpoint does not have any parameters.
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
### Return type
|
|
244
|
+
|
|
245
|
+
**AdminDashboardOverview**
|
|
246
|
+
|
|
247
|
+
### Authorization
|
|
248
|
+
|
|
249
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
250
|
+
|
|
251
|
+
### HTTP request headers
|
|
252
|
+
|
|
253
|
+
- **Content-Type**: Not defined
|
|
254
|
+
- **Accept**: application/json
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
### HTTP response details
|
|
258
|
+
| Status code | Description | Response headers |
|
|
259
|
+
|-------------|-------------|------------------|
|
|
260
|
+
|**200** | Overview tiles | - |
|
|
261
|
+
|
|
262
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
263
|
+
|
|
264
|
+
# **punishmentsByType**
|
|
265
|
+
> Array<AdminDashboardPunishmentDaily> punishmentsByType()
|
|
266
|
+
|
|
267
|
+
Daily punishment issuance over the window, split by type (BAN/MUTE/KICK/WARNING) — feeds the stacked chart.
|
|
268
|
+
|
|
269
|
+
### Example
|
|
270
|
+
|
|
271
|
+
```typescript
|
|
272
|
+
import {
|
|
273
|
+
AdminDashboardApi,
|
|
274
|
+
Configuration
|
|
275
|
+
} from '@rebornteam/reborn-api';
|
|
276
|
+
|
|
277
|
+
const configuration = new Configuration();
|
|
278
|
+
const apiInstance = new AdminDashboardApi(configuration);
|
|
279
|
+
|
|
280
|
+
let days: number; //Trailing window in days (optional) (default to 30)
|
|
281
|
+
|
|
282
|
+
const { status, data } = await apiInstance.punishmentsByType(
|
|
283
|
+
days
|
|
284
|
+
);
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
### Parameters
|
|
288
|
+
|
|
289
|
+
|Name | Type | Description | Notes|
|
|
290
|
+
|------------- | ------------- | ------------- | -------------|
|
|
291
|
+
| **days** | [**number**] | Trailing window in days | (optional) defaults to 30|
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
### Return type
|
|
295
|
+
|
|
296
|
+
**Array<AdminDashboardPunishmentDaily>**
|
|
297
|
+
|
|
298
|
+
### Authorization
|
|
299
|
+
|
|
300
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
301
|
+
|
|
302
|
+
### HTTP request headers
|
|
303
|
+
|
|
304
|
+
- **Content-Type**: Not defined
|
|
305
|
+
- **Accept**: application/json
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
### HTTP response details
|
|
309
|
+
| Status code | Description | Response headers |
|
|
310
|
+
|-------------|-------------|------------------|
|
|
311
|
+
|**200** | Daily punishment counts by type | - |
|
|
312
|
+
|
|
313
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
314
|
+
|
|
315
|
+
# **reportSummary**
|
|
316
|
+
> AdminDashboardReportSummary reportSummary()
|
|
317
|
+
|
|
318
|
+
Open backlog, reports resolved in the window, mean resolution time, and a category breakdown.
|
|
319
|
+
|
|
320
|
+
### Example
|
|
321
|
+
|
|
322
|
+
```typescript
|
|
323
|
+
import {
|
|
324
|
+
AdminDashboardApi,
|
|
325
|
+
Configuration
|
|
326
|
+
} from '@rebornteam/reborn-api';
|
|
327
|
+
|
|
328
|
+
const configuration = new Configuration();
|
|
329
|
+
const apiInstance = new AdminDashboardApi(configuration);
|
|
330
|
+
|
|
331
|
+
let days: number; //Trailing window in days (optional) (default to 30)
|
|
332
|
+
|
|
333
|
+
const { status, data } = await apiInstance.reportSummary(
|
|
334
|
+
days
|
|
335
|
+
);
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
### Parameters
|
|
339
|
+
|
|
340
|
+
|Name | Type | Description | Notes|
|
|
341
|
+
|------------- | ------------- | ------------- | -------------|
|
|
342
|
+
| **days** | [**number**] | Trailing window in days | (optional) defaults to 30|
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
### Return type
|
|
346
|
+
|
|
347
|
+
**AdminDashboardReportSummary**
|
|
348
|
+
|
|
349
|
+
### Authorization
|
|
350
|
+
|
|
351
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
352
|
+
|
|
353
|
+
### HTTP request headers
|
|
354
|
+
|
|
355
|
+
- **Content-Type**: Not defined
|
|
356
|
+
- **Accept**: application/json
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
### HTTP response details
|
|
360
|
+
| Status code | Description | Response headers |
|
|
361
|
+
|-------------|-------------|------------------|
|
|
362
|
+
|**200** | Report summary | - |
|
|
363
|
+
|
|
364
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
365
|
+
|
|
366
|
+
# **serverRegions**
|
|
367
|
+
> Array<AdminDashboardServerRegion> serverRegions()
|
|
368
|
+
|
|
369
|
+
Online server count and current player load per region/game-type.
|
|
370
|
+
|
|
371
|
+
### Example
|
|
372
|
+
|
|
373
|
+
```typescript
|
|
374
|
+
import {
|
|
375
|
+
AdminDashboardApi,
|
|
376
|
+
Configuration
|
|
377
|
+
} from '@rebornteam/reborn-api';
|
|
378
|
+
|
|
379
|
+
const configuration = new Configuration();
|
|
380
|
+
const apiInstance = new AdminDashboardApi(configuration);
|
|
381
|
+
|
|
382
|
+
const { status, data } = await apiInstance.serverRegions();
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
### Parameters
|
|
386
|
+
This endpoint does not have any parameters.
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
### Return type
|
|
390
|
+
|
|
391
|
+
**Array<AdminDashboardServerRegion>**
|
|
392
|
+
|
|
393
|
+
### Authorization
|
|
394
|
+
|
|
395
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
396
|
+
|
|
397
|
+
### HTTP request headers
|
|
398
|
+
|
|
399
|
+
- **Content-Type**: Not defined
|
|
400
|
+
- **Accept**: application/json
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
### HTTP response details
|
|
404
|
+
| Status code | Description | Response headers |
|
|
405
|
+
|-------------|-------------|------------------|
|
|
406
|
+
|**200** | Per-region server summary | - |
|
|
407
|
+
|
|
408
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
409
|
+
|
|
410
|
+
# **topModerators**
|
|
411
|
+
> Array<AdminDashboardModeratorActivity> topModerators()
|
|
412
|
+
|
|
413
|
+
Moderators ranked by audit-log action count over the window.
|
|
414
|
+
|
|
415
|
+
### Example
|
|
416
|
+
|
|
417
|
+
```typescript
|
|
418
|
+
import {
|
|
419
|
+
AdminDashboardApi,
|
|
420
|
+
Configuration
|
|
421
|
+
} from '@rebornteam/reborn-api';
|
|
422
|
+
|
|
423
|
+
const configuration = new Configuration();
|
|
424
|
+
const apiInstance = new AdminDashboardApi(configuration);
|
|
425
|
+
|
|
426
|
+
let days: number; //Trailing window in days (optional) (default to 30)
|
|
427
|
+
let limit: number; //Max moderators to return (optional) (default to 10)
|
|
428
|
+
|
|
429
|
+
const { status, data } = await apiInstance.topModerators(
|
|
430
|
+
days,
|
|
431
|
+
limit
|
|
432
|
+
);
|
|
433
|
+
```
|
|
434
|
+
|
|
435
|
+
### Parameters
|
|
436
|
+
|
|
437
|
+
|Name | Type | Description | Notes|
|
|
438
|
+
|------------- | ------------- | ------------- | -------------|
|
|
439
|
+
| **days** | [**number**] | Trailing window in days | (optional) defaults to 30|
|
|
440
|
+
| **limit** | [**number**] | Max moderators to return | (optional) defaults to 10|
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
### Return type
|
|
444
|
+
|
|
445
|
+
**Array<AdminDashboardModeratorActivity>**
|
|
446
|
+
|
|
447
|
+
### Authorization
|
|
448
|
+
|
|
449
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
450
|
+
|
|
451
|
+
### HTTP request headers
|
|
452
|
+
|
|
453
|
+
- **Content-Type**: Not defined
|
|
454
|
+
- **Accept**: application/json
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
### HTTP response details
|
|
458
|
+
| Status code | Description | Response headers |
|
|
459
|
+
|-------------|-------------|------------------|
|
|
460
|
+
|**200** | Moderator leaderboard | - |
|
|
461
|
+
|
|
462
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
463
|
+
|
|
464
|
+
# **trustDistribution**
|
|
465
|
+
> Array<AdminDashboardTrustBucket> trustDistribution()
|
|
466
|
+
|
|
467
|
+
Histogram of every player\'s latest trust factor, bucketed into ten 10-point bins.
|
|
468
|
+
|
|
469
|
+
### Example
|
|
470
|
+
|
|
471
|
+
```typescript
|
|
472
|
+
import {
|
|
473
|
+
AdminDashboardApi,
|
|
474
|
+
Configuration
|
|
475
|
+
} from '@rebornteam/reborn-api';
|
|
476
|
+
|
|
477
|
+
const configuration = new Configuration();
|
|
478
|
+
const apiInstance = new AdminDashboardApi(configuration);
|
|
479
|
+
|
|
480
|
+
const { status, data } = await apiInstance.trustDistribution();
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
### Parameters
|
|
484
|
+
This endpoint does not have any parameters.
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
### Return type
|
|
488
|
+
|
|
489
|
+
**Array<AdminDashboardTrustBucket>**
|
|
490
|
+
|
|
491
|
+
### Authorization
|
|
492
|
+
|
|
493
|
+
[DiscordAuth](../README.md#DiscordAuth)
|
|
494
|
+
|
|
495
|
+
### HTTP request headers
|
|
496
|
+
|
|
497
|
+
- **Content-Type**: Not defined
|
|
498
|
+
- **Accept**: application/json
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
### HTTP response details
|
|
502
|
+
| Status code | Description | Response headers |
|
|
503
|
+
|-------------|-------------|------------------|
|
|
504
|
+
|**200** | Trust-factor histogram buckets | - |
|
|
505
|
+
|
|
506
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
507
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# AdminDashboardCategoryCount
|
|
2
|
+
|
|
3
|
+
Report count for one category over the window.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**category** | **string** | Report category | [default to undefined]
|
|
10
|
+
**count** | **number** | Reports filed in this category | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AdminDashboardCategoryCount } from '@rebornteam/reborn-api';
|
|
16
|
+
|
|
17
|
+
const instance: AdminDashboardCategoryCount = {
|
|
18
|
+
category,
|
|
19
|
+
count,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AdminDashboardCountryCount
|
|
2
|
+
|
|
3
|
+
Connection volume for one country over the requested window.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**country** | **string** | ISO country code | [default to undefined]
|
|
10
|
+
**connections** | **number** | Distinct connections geolocated to this country | [default to undefined]
|
|
11
|
+
**vpnConnections** | **number** | Of those, how many were flagged VPN/proxy | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { AdminDashboardCountryCount } from '@rebornteam/reborn-api';
|
|
17
|
+
|
|
18
|
+
const instance: AdminDashboardCountryCount = {
|
|
19
|
+
country,
|
|
20
|
+
connections,
|
|
21
|
+
vpnConnections,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# AdminDashboardDailySessions
|
|
2
|
+
|
|
3
|
+
One day of the session-activity timeseries (UTC day).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**day** | **string** | UTC day, YYYY-MM-DD | [default to undefined]
|
|
10
|
+
**sessionCount** | **number** | Sessions started this day | [default to undefined]
|
|
11
|
+
**activePlayers** | **number** | Distinct players active this day | [default to undefined]
|
|
12
|
+
**avgDurationSeconds** | **number** | Mean completed-session length this day, seconds | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { AdminDashboardDailySessions } from '@rebornteam/reborn-api';
|
|
18
|
+
|
|
19
|
+
const instance: AdminDashboardDailySessions = {
|
|
20
|
+
day,
|
|
21
|
+
sessionCount,
|
|
22
|
+
activePlayers,
|
|
23
|
+
avgDurationSeconds,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# AdminDashboardModeratorActivity
|
|
2
|
+
|
|
3
|
+
A moderator and their audit-log action count over the window.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**actor** | **string** | Moderator username | [default to undefined]
|
|
10
|
+
**actionCount** | **number** | Audit-log actions performed | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AdminDashboardModeratorActivity } from '@rebornteam/reborn-api';
|
|
16
|
+
|
|
17
|
+
const instance: AdminDashboardModeratorActivity = {
|
|
18
|
+
actor,
|
|
19
|
+
actionCount,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|