Melody User Service API

admin-controller

Endpointhttps://melody-gateway-main-0d30d7f.d2.zuplo.dev

Get user by ID (Admin only)

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/{userId}

Returns detailed information about a specific user. Only accessible by administrators.

Get user by ID (Admin only) › path Parameters

userId

string · uuid · required

User ID

Get user by ID (Admin only) › Responses

User retrieved successfully

User response DTO with administrative details for use in Admin panel

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User Region

isBlocked

boolean

Indicates if the user is blocked

blockedAt

string · date-time

Timestamp when the user was blocked in ISO-8601 UTC format. Null if not blocked

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

profilePictureUrl

string

URL or path to the user's profile picture

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

contentFilterEnabled

boolean

User's content filter flag

lastLogin

string · date-time

Last Login timestamp in ISO-8601 UTC format

GET/users/admin/{userId}

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/:userId

shell

Example Responses

{
  "id": "dnisdpajodj3rjnj55kq1l12l3n5jb5l",
  "email": "example@mail.com",
  "username": "JuanPerez2007",
  "role": "LISTENER",
  "region": "SAM",
  "isBlocked": false,
  "blockedAt": "2025-11-02T18:30:00Z",
  "firstName": "Juan",
  "lastName": "Perez",
  "phoneNumber": "+5445671239",
  "address": "Francisco Pizarro 2999, CABA, Argentina",
  "profilePictureUrl": "/images/profiles/juanperez2007.jpg",
  "followersCount": 150,
  "followingCount": 75,
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "contentFilterEnabled": true,
  "lastLogin": "2025-09-14T12:34:56Z"
}

json

application/json

Update user completely (Admin only)

PUT

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/{userId}

Updates user fields except role. Administrators cannot modify user roles. Only accessible by administrators.

Update user completely (Admin only) › path Parameters

userId

string · uuid · required

User ID

Update user completely (Admin only) › Request Body

Request DTO for updating a user by admin (role cannot be changed)

email

string

Email address of the user

username

string · minLength: 3 · maxLength: 50

Username of the user

region

string

Region of the user

isBlocked

boolean

Indicates if the user is blocked

firstName

string · minLength: 0 · maxLength: 50

First name of the user

lastName

string · minLength: 0 · maxLength: 50

Last name of the user

phoneNumber

string · pattern: ^$|^\+?[0-9]{10,15}$

User's phone number

address

string · minLength: 0 · maxLength: 500

Address of the user

profilePictureUrl

string · minLength: 0 · maxLength: 500

URL or path to the user's profile picture

biography

string · minLength: 0 · maxLength: 1000

Short biography or description of the user

contentFilterEnabled

boolean

User's content filter flag

Update user completely (Admin only) › Responses

User updated successfully

User response DTO with administrative details for use in Admin panel

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User Region

isBlocked

boolean

Indicates if the user is blocked

blockedAt

string · date-time

Timestamp when the user was blocked in ISO-8601 UTC format. Null if not blocked

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

profilePictureUrl

string

URL or path to the user's profile picture

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

contentFilterEnabled

boolean

User's content filter flag

lastLogin

string · date-time

Last Login timestamp in ISO-8601 UTC format

PUT/users/admin/{userId}

curl --request PUT \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/:userId \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "username": "johndoe",
  "region": "SAM",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+541112345678",
  "address": 123,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "biography": "Music lover and guitarist",
  "contentFilterEnabled": true
}
'

shell

Example Request Body

{
  "email": "user@example.com",
  "username": "johndoe",
  "region": "SAM",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+541112345678",
  "address": 123,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "biography": "Music lover and guitarist",
  "contentFilterEnabled": true
}

json

Example Responses

{
  "id": "dnisdpajodj3rjnj55kq1l12l3n5jb5l",
  "email": "example@mail.com",
  "username": "JuanPerez2007",
  "role": "LISTENER",
  "region": "SAM",
  "isBlocked": false,
  "blockedAt": "2025-11-02T18:30:00Z",
  "firstName": "Juan",
  "lastName": "Perez",
  "phoneNumber": "+5445671239",
  "address": "Francisco Pizarro 2999, CABA, Argentina",
  "profilePictureUrl": "/images/profiles/juanperez2007.jpg",
  "followersCount": 150,
  "followingCount": 75,
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "contentFilterEnabled": true,
  "lastLogin": "2025-09-14T12:34:56Z"
}

json

application/json

Delete user (Admin only)

DELETE

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/{userId}

Deletes a user from the system. Only accessible by administrators.

Delete user (Admin only) › path Parameters

userId

string · uuid · required

User ID

Delete user (Admin only) › Responses

User deleted successfully

No data returned

DELETE/users/admin/{userId}

curl --request DELETE \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/:userId

shell

Example Responses

No example specified for this content type

application/json

Get all users (Admin only)

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin

Returns a paginated list of all users in the system. Only accessible by administrators.

Get all users (Admin only) › query Parameters

page

integer · int32

Page number (0-based)

Default: 0

size

integer · int32

Page size

Default: 20

search

string

role

string · enum

User role type: LISTENER, ARTIST, UNDECLARED

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

isBlocked

boolean

Get all users (Admin only) › Responses

Users retrieved successfully

totalElements

integer · int64

totalPages

integer · int32

numberOfElements

integer · int32

object

size

integer · int32

object[]

number

integer · int32

object

first

boolean

last

boolean

empty

boolean

GET/users/admin

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin

shell

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "numberOfElements": 0,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "pageNumber": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "size": 0,
  "content": [
    {}
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

json

application/json

Create new admin user (Admin only)

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin

Creates a new admin user in the system. Administrators can only create users with ADMIN role. Only accessible by administrators.

Create new admin user (Admin only) › Request Body

Request DTO for creating a new admin user

email

string · required

Email address of the user

password

string · minLength: 5 · maxLength: 20 · required

Password for the user account

username

string · minLength: 3 · maxLength: 50 · required

Username of the user

isBlocked

boolean

Indicates if the user is blocked

firstName

string · minLength: 0 · maxLength: 50

First name of the user

lastName

string · minLength: 0 · maxLength: 50

Last name of the user

phoneNumber

string · pattern: ^$|^\+?[0-9]{10,15}$

User's phone number

address

string · minLength: 0 · maxLength: 500

Address of the user

profilePictureUrl

string · minLength: 0 · maxLength: 500

URL or path to the user's profile picture

biography

string · minLength: 0 · maxLength: 1000

Short biography or description of the user

contentFilterEnabled

boolean

User's content filter flag

Create new admin user (Admin only) › Responses

Admin user created successfully

User response DTO with administrative details for use in Admin panel

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User Region

isBlocked

boolean

Indicates if the user is blocked

blockedAt

string · date-time

Timestamp when the user was blocked in ISO-8601 UTC format. Null if not blocked

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

profilePictureUrl

string

URL or path to the user's profile picture

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

contentFilterEnabled

boolean

User's content filter flag

lastLogin

string · date-time

Last Login timestamp in ISO-8601 UTC format

POST/users/admin

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "admin@example.com",
  "password": "securePassword123",
  "username": "adminuser",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+541112345678",
  "address": 123,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "biography": "System administrator",
  "contentFilterEnabled": true
}
'

shell

Example Request Body

{
  "email": "admin@example.com",
  "password": "securePassword123",
  "username": "adminuser",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+541112345678",
  "address": 123,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "biography": "System administrator",
  "contentFilterEnabled": true
}

json

Example Responses

{
  "id": "dnisdpajodj3rjnj55kq1l12l3n5jb5l",
  "email": "example@mail.com",
  "username": "JuanPerez2007",
  "role": "LISTENER",
  "region": "SAM",
  "isBlocked": false,
  "blockedAt": "2025-11-02T18:30:00Z",
  "firstName": "Juan",
  "lastName": "Perez",
  "phoneNumber": "+5445671239",
  "address": "Francisco Pizarro 2999, CABA, Argentina",
  "profilePictureUrl": "/images/profiles/juanperez2007.jpg",
  "followersCount": 150,
  "followingCount": 75,
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "contentFilterEnabled": true,
  "lastLogin": "2025-09-14T12:34:56Z"
}

json

application/json

Unblock user (Admin only)

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/{userId}/unblock

Unblocks a user. Only accessible by administrators.

Unblock user (Admin only) › path Parameters

userId

string · uuid · required

User ID

Unblock user (Admin only) › Responses

User unblocked successfully

User response DTO with administrative details for use in Admin panel

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User Region

isBlocked

boolean

Indicates if the user is blocked

blockedAt

string · date-time

Timestamp when the user was blocked in ISO-8601 UTC format. Null if not blocked

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

profilePictureUrl

string

URL or path to the user's profile picture

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

contentFilterEnabled

boolean

User's content filter flag

lastLogin

string · date-time

Last Login timestamp in ISO-8601 UTC format

POST/users/admin/{userId}/unblock

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/:userId/unblock

shell

Example Responses

{
  "id": "dnisdpajodj3rjnj55kq1l12l3n5jb5l",
  "email": "example@mail.com",
  "username": "JuanPerez2007",
  "role": "LISTENER",
  "region": "SAM",
  "isBlocked": false,
  "blockedAt": "2025-11-02T18:30:00Z",
  "firstName": "Juan",
  "lastName": "Perez",
  "phoneNumber": "+5445671239",
  "address": "Francisco Pizarro 2999, CABA, Argentina",
  "profilePictureUrl": "/images/profiles/juanperez2007.jpg",
  "followersCount": 150,
  "followingCount": 75,
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "contentFilterEnabled": true,
  "lastLogin": "2025-09-14T12:34:56Z"
}

json

application/json

Block user (Admin only)

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/{userId}/block

Blocks a user and revokes all their tokens. Only accessible by administrators.

Block user (Admin only) › path Parameters

userId

string · uuid · required

User ID

Block user (Admin only) › Responses

User blocked successfully

User response DTO with administrative details for use in Admin panel

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User Region

isBlocked

boolean

Indicates if the user is blocked

blockedAt

string · date-time

Timestamp when the user was blocked in ISO-8601 UTC format. Null if not blocked

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

profilePictureUrl

string

URL or path to the user's profile picture

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

contentFilterEnabled

boolean

User's content filter flag

lastLogin

string · date-time

Last Login timestamp in ISO-8601 UTC format

POST/users/admin/{userId}/block

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/:userId/block

shell

Example Responses

{
  "id": "dnisdpajodj3rjnj55kq1l12l3n5jb5l",
  "email": "example@mail.com",
  "username": "JuanPerez2007",
  "role": "LISTENER",
  "region": "SAM",
  "isBlocked": false,
  "blockedAt": "2025-11-02T18:30:00Z",
  "firstName": "Juan",
  "lastName": "Perez",
  "phoneNumber": "+5445671239",
  "address": "Francisco Pizarro 2999, CABA, Argentina",
  "profilePictureUrl": "/images/profiles/juanperez2007.jpg",
  "followersCount": 150,
  "followingCount": 75,
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "contentFilterEnabled": true,
  "lastLogin": "2025-09-14T12:34:56Z"
}

json

application/json

Update user blocked status only (Admin only)

PATCH

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/{userId}/status

Updates only the blocked status of a user. Role modification is not allowed. Only accessible by administrators.

Update user blocked status only (Admin only) › path Parameters

userId

string · uuid · required

User ID

Update user blocked status only (Admin only) › Request Body

Request DTO for updating user blocked status by admin

isBlocked

boolean

Indicates if the user is blocked

Update user blocked status only (Admin only) › Responses

User blocked status updated successfully

User response DTO with administrative details for use in Admin panel

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User Region

isBlocked

boolean

Indicates if the user is blocked

blockedAt

string · date-time

Timestamp when the user was blocked in ISO-8601 UTC format. Null if not blocked

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

profilePictureUrl

string

URL or path to the user's profile picture

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

contentFilterEnabled

boolean

User's content filter flag

lastLogin

string · date-time

Last Login timestamp in ISO-8601 UTC format

PATCH/users/admin/{userId}/status

curl --request PATCH \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/:userId/status \
  --header 'Content-Type: application/json' \
  --data '
{
  "isBlocked": false
}
'

shell

Example Request Body

{
  "isBlocked": false
}

json

Example Responses

{
  "id": "dnisdpajodj3rjnj55kq1l12l3n5jb5l",
  "email": "example@mail.com",
  "username": "JuanPerez2007",
  "role": "LISTENER",
  "region": "SAM",
  "isBlocked": false,
  "blockedAt": "2025-11-02T18:30:00Z",
  "firstName": "Juan",
  "lastName": "Perez",
  "phoneNumber": "+5445671239",
  "address": "Francisco Pizarro 2999, CABA, Argentina",
  "profilePictureUrl": "/images/profiles/juanperez2007.jpg",
  "followersCount": 150,
  "followingCount": 75,
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "contentFilterEnabled": true,
  "lastLogin": "2025-09-14T12:34:56Z"
}

json

application/json

Get total users metrics (Admin only)

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/metrics/total-users

Returns total users count with regional breakdown and percentage change compared to previous period. Only accessible by administrators.

Get total users metrics (Admin only) › query Parameters

period

string · enum · required

Time period for metrics

Time period for metrics filtering

Enum values:

LAST_DAY

LAST_WEEK

LAST_MONTH

Default: LAST_DAY

Get total users metrics (Admin only) › Responses

Total users metrics retrieved successfully

Total users metrics with regional breakdown

totalUsers

integer · int64

Total number of users

object[]

Users count by region

changePercentage

number · double

Percentage change compared to previous period

GET/users/admin/metrics/total-users

curl --request GET \
  --url 'https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/metrics/total-users?period=LAST_DAY'

shell

Example Responses

{
  "totalUsers": 1000,
  "regionalBreakdown": [
    {
      "region": "NAM",
      "count": 150
    }
  ],
  "changePercentage": 5.5
}

json

application/json

Get role distribution metrics (Admin only)

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/metrics/role-distribution

Returns user count distribution by role with total and regional breakdown and percentage change. Only accessible by administrators.

Get role distribution metrics (Admin only) › query Parameters

period

string · enum · required

Time period for metrics

Time period for metrics filtering

Enum values:

LAST_DAY

LAST_WEEK

LAST_MONTH

Default: LAST_DAY

Get role distribution metrics (Admin only) › Responses

Role distribution metrics retrieved successfully

Role distribution metrics

object[]

User counts by role

object[]

User counts by role and region

changePercentage

number · double

Percentage change compared to previous period

GET/users/admin/metrics/role-distribution

curl --request GET \
  --url 'https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/metrics/role-distribution?period=LAST_DAY'

shell

Example Responses

{
  "totalRoleDistribution": [
    {
      "role": "LISTENER",
      "count": 500
    }
  ],
  "regionalRoleDistribution": [
    {
      "role": "ARTIST",
      "region": "EUW",
      "count": 75
    }
  ],
  "changePercentage": 2.1
}

json

application/json

Get most recent signups (Admin only)

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/metrics/recent-signups

Returns the most recent artist and listener signups. Only accessible by administrators.

Get most recent signups (Admin only) › Responses

Recent signups retrieved successfully

Most recent signups by role

object

Recent user signup information

object

Recent user signup information

GET/users/admin/metrics/recent-signups

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/metrics/recent-signups

shell

Example Responses

{
  "lastArtist": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "johndoe",
    "email": "john@example.com",
    "createdAt": "2025-10-01T12:00:00Z"
  },
  "lastListener": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "johndoe",
    "email": "john@example.com",
    "createdAt": "2025-10-01T12:00:00Z"
  }
}

json

application/json

Get new sign ups metrics (Admin only)

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/metrics/new-signups

Returns count of new user signups in the specified period with percentage change. Only accessible by administrators.

Get new sign ups metrics (Admin only) › query Parameters

period

string · enum · required

Time period for metrics

Time period for metrics filtering

Enum values:

LAST_DAY

LAST_WEEK

LAST_MONTH

Default: LAST_DAY

Get new sign ups metrics (Admin only) › Responses

New sign ups metrics retrieved successfully

New sign ups metrics

newSignUps

integer · int64

Total number of new sign ups in the period

changePercentage

number · double

Percentage change compared to previous period

GET/users/admin/metrics/new-signups

curl --request GET \
  --url 'https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/metrics/new-signups?period=LAST_DAY'

shell

Example Responses

{
  "newSignUps": 120,
  "changePercentage": 10.5
}

json

application/json

Get blocked users metrics (Admin only)

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/metrics/blocked-users

Returns count of blocked users with regional breakdown and percentage change. Only accessible by administrators.

Get blocked users metrics (Admin only) › query Parameters

period

string · enum · required

Time period for metrics

Time period for metrics filtering

Enum values:

LAST_DAY

LAST_WEEK

LAST_MONTH

Default: LAST_DAY

Get blocked users metrics (Admin only) › Responses

Blocked users metrics retrieved successfully

Blocked users metrics with regional breakdown

totalBlockedUsers

integer · int64

Total number of blocked users

object[]

Blocked users count by region

changePercentage

number · double

Percentage change compared to previous period

GET/users/admin/metrics/blocked-users

curl --request GET \
  --url 'https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/metrics/blocked-users?period=LAST_DAY'

shell

Example Responses

{
  "totalBlockedUsers": 25,
  "regionalBreakdown": [
    {
      "region": "NAM",
      "count": 150
    }
  ],
  "changePercentage": -5
}

json

application/json

Get active users metrics (Admin only)

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/admin/metrics/active-users

Returns count of active users (users with last login in period) with percentage change. Only accessible by administrators.

Get active users metrics (Admin only) › query Parameters

period

string · enum · required

Time period for metrics

Time period for metrics filtering

Enum values:

LAST_DAY

LAST_WEEK

LAST_MONTH

Default: LAST_DAY

Get active users metrics (Admin only) › Responses

Active users metrics retrieved successfully

Active users (last logins) metrics

activeUsers

integer · int64

Total number of active users in the period

changePercentage

number · double

Percentage change compared to previous period

GET/users/admin/metrics/active-users

curl --request GET \
  --url 'https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/admin/metrics/active-users?period=LAST_DAY'

shell

Example Responses

{
  "activeUsers": 450,
  "changePercentage": 3.2
}

json

application/json

artist-controller internal-metrics-controller