Skip to main content
GET
/
v1
/
api
/
superadmin
/
dashboard
/
period
Get statistics for a specific period
curl --request GET \
  --url http://localhost:3091/v1/api/superadmin/dashboard/period \
  --header 'Authorization: Bearer <token>'
{
  "totalUsers": 123,
  "activeUsers": 123,
  "bannedUsers": 123,
  "newUsersThisMonth": 123,
  "newUsersLastMonth": 123,
  "userGrowthPercent": 123,
  "pendingKyc": 123,
  "approvedKyc": 123,
  "rejectedKyc": 123,
  "kycApprovalRate": 123,
  "totalReservations": 123,
  "pendingReservations": 123,
  "completedReservations": 123,
  "cancelledReservations": 123,
  "disputedReservations": 123,
  "totalAnnonces": 123,
  "activeAnnonces": 123,
  "expiredAnnonces": 123,
  "totalRevenue": 123,
  "totalCommissions": 123,
  "revenueThisMonth": 123,
  "revenueLastMonth": 123,
  "revenueGrowthPercent": 123,
  "pendingWithdrawals": 123,
  "totalWithdrawnAmount": 123,
  "pendingWithdrawalsCount": 123,
  "monthlyUsers": [
    {
      "year": 123,
      "month": 123,
      "monthName": "<string>",
      "value": 123,
      "count": 123
    }
  ],
  "monthlyRevenue": [
    {
      "year": 123,
      "month": 123,
      "monthName": "<string>",
      "value": 123,
      "count": 123
    }
  ],
  "monthlyReservations": [
    {
      "year": 123,
      "month": 123,
      "monthName": "<string>",
      "value": 123,
      "count": 123
    }
  ],
  "reservationsByStatus": {},
  "usersByRole": {}
}

Authorizations

Authorization
string
header
required

JWT access token from POST /v1/api/auth/login

Query Parameters

startDate
string<date-time>
required
endDate
string<date-time>
required

Response

Period statistics retrieved

totalUsers
integer<int64>
activeUsers
integer<int64>
bannedUsers
integer<int64>
newUsersThisMonth
integer<int64>
newUsersLastMonth
integer<int64>
userGrowthPercent
number<double>
pendingKyc
integer<int64>
approvedKyc
integer<int64>
rejectedKyc
integer<int64>
kycApprovalRate
number<double>
totalReservations
integer<int64>
pendingReservations
integer<int64>
completedReservations
integer<int64>
cancelledReservations
integer<int64>
disputedReservations
integer<int64>
totalAnnonces
integer<int64>
activeAnnonces
integer<int64>
expiredAnnonces
integer<int64>
totalRevenue
number
totalCommissions
number
revenueThisMonth
number
revenueLastMonth
number
revenueGrowthPercent
number
pendingWithdrawals
number
totalWithdrawnAmount
number
pendingWithdrawalsCount
integer<int32>
monthlyUsers
object[]
monthlyRevenue
object[]
monthlyReservations
object[]
reservationsByStatus
object
usersByRole
object