Description: Respond when the great action is done
Ratelimit: 5 per 10s
Permission: player-greats.manage
Required parameters
Name Type Description
serverId number The server id
id number The great id you wan't to get the status
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_SERVER_ID The server id is invalid
401 UNAUTHORIZED The token is invalid or expired
403 ACCESS_DENIED The token or the author does not have the required permissions
403 CANNOT_DO_SELF_ACTION You cannot do this action on yourself if you don't have the administrator permission
403 DISCORD_CONNECTION_REQUIRED You need a Discord account link to your Steam Account to access to the route
404 SERVER_NOT_FOUND The server does not exist
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"

Description: Fetch greats
Ratelimit: 5 per 10s
Permission: player-greats.manage
Required parameters
Name Type Description
serverId number The server id
Query parameters
Name Type Description Default
from date The start date where you wan't to fetch the statistics ❌
to date The end date where you wan't to fetch the statistics ❌
great number The great value you want to fetch ❌
page number The page number (min: 1) 1
perpage number The limit of elements per page (min: 1, max: 100) 10
search string The search query (only first 50 characters will be considered) ❌
sortby string The column to sort by id
sortdir string The direction to sort by (enum: asc | desc) desc
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_FROM The value doesn't follow the requirements
400 INVALID_GREAT The value doesn't follow the requirements
400 INVALID_PAGE The value doesn't follow the requirements
400 INVALID_PERPAGE The value doesn't follow the requirements
400 INVALID_SEARCH The value doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_SORTBY The value doesn't follow the requirements
400 INVALID_SORTDIR The value doesn't follow the requirements
400 INVALID_TO The value doesn't follow the requirements
401 UNAUTHORIZED The token is invalid or expired
403 ACCESS_DENIED The token or the author does not have the required permissions
403 DISCORD_CONNECTION_REQUIRED You need a Discord account link to your Steam Account to access to the route
404 SERVER_NOT_FOUND The server does not exist
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"
  • data[]:
    • id: number
    • targetId: number
    • great: number
    • description: string
    • active: boolean
    • authorId: number
    • authorName: string
    • author:
      • id: number
      • name: string
      • uuid: string
      • firstConnection: date
      • lastConnection: date
      • lastDashboardConnection: date | null
      • accountName: string | null
      • accountType: string
      • accountId: number
      • avatarUrl: string
      • discordUsername: string | null
      • discordDiscriminator: string | null
      • serverId: number
      • roles[]:
        • serverId: number
        • id: number
        • name: string
        • color: string
        • position: number | null
        • categories:
          • id: number
          • name: string
        • deletedAt: date | null
      • language:
        • alpha2: string
        • name: string
    • target:
      • id: number
      • name: string
      • uuid: string
      • firstConnection: date
      • lastConnection: date
      • lastDashboardConnection: date | null
      • accountName: string | null
      • accountType: string
      • accountId: number
      • avatarUrl: string
      • discordUsername: string | null
      • discordDiscriminator: string | null
      • serverId: number
      • roles[]:
        • serverId: number
        • id: number
        • name: string
        • color: string
        • position: number | null
        • categories:
          • id: number
          • name: string
        • deletedAt: date | null
      • language:
        • alpha2: string
        • name: string
    • serverId: number
    • date: date
  • pagination:
    • currentPage: number
    • perPage: number
    • total: number
    • totalFiltered: number
    • totalOnPage: number
    • sort:
      • by: string
      • dir:
    • search: string | null

Description: Fetch your greats
Ratelimit: 5 per 10s
Permission: player-greats.read
Required parameters
Name Type Description
serverId number The server id
Query parameters
Name Type Description Default
from date The start date where you wan't to fetch the statistics ❌
to date The end date where you wan't to fetch the statistics ❌
great number The great value you wan't to fetch ❌
page number The page number (min: 1) 1
perpage number The limit of elements per page (min: 1, max: 100) 10
search string The search query (only first 50 characters will be considered) ❌
sortby string The column to sort by id
sortdir string The direction to sort by (enum: asc | desc) desc
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_FROM The value doesn't follow the requirements
400 INVALID_GREAT The value doesn't follow the requirements
400 INVALID_PAGE The value doesn't follow the requirements
400 INVALID_PERPAGE The value doesn't follow the requirements
400 INVALID_SEARCH The value doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_SORTBY The value doesn't follow the requirements
400 INVALID_SORTDIR The value doesn't follow the requirements
400 INVALID_TO The value doesn't follow the requirements
401 UNAUTHORIZED The token is invalid or expired
403 ACCESS_DENIED The token or the author does not have the required permissions
403 DISCORD_CONNECTION_REQUIRED You need a Discord account link to your Steam Account to access to the route
404 SERVER_NOT_FOUND The server does not exist
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"
  • data[]:
    • id: number
    • targetId: number
    • great: number
    • description: string
    • active: boolean
    • authorId: number
    • authorName: string
    • author:
      • id: number
      • name: string
      • uuid: string
      • firstConnection: date
      • lastConnection: date
      • lastDashboardConnection: date | null
      • accountName: string | null
      • accountType: string
      • accountId: number
      • avatarUrl: string
      • discordUsername: string | null
      • discordDiscriminator: string | null
      • serverId: number
      • roles[]:
        • serverId: number
        • id: number
        • name: string
        • color: string
        • position: number | null
        • categories:
          • id: number
          • name: string
        • deletedAt: date | null
      • language:
        • alpha2: string
        • name: string
    • serverId: number
    • date: date
  • pagination:
    • currentPage: number
    • perPage: number
    • total: number
    • totalFiltered: number
    • totalOnPage: number
    • sort:
      • by: string
      • dir:
    • search: string | null

Description: Fetch your greats amount per day
Ratelimit: 5 per 10s
Permission: player-greats.read
Required parameters
Name Type Description
serverId number The server id
Query parameters
Name Type Description Default
from date The start date where you wan't to fetch the statistics ❌
to date The end date where you wan't to fetch the statistics ❌
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_FROM The value doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_TO The value doesn't follow the requirements
401 UNAUTHORIZED The token is invalid or expired
403 ACCESS_DENIED The token or the author does not have the required permissions
403 DISCORD_CONNECTION_REQUIRED You need a Discord account link to your Steam Account to access to the route
404 SERVER_NOT_FOUND The server does not exist
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"
  • data[]:
    • amount: number
    • date: date

Description: Fetch your greats average per day
Ratelimit: 5 per 10s
Permission: player-greats.read
Required parameters
Name Type Description
serverId number The server id
Query parameters
Name Type Description Default
from date The start date where you wan't to fetch the statistics ❌
to date The end date where you wan't to fetch the statistics ❌
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_FROM The value doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_TO The value doesn't follow the requirements
401 UNAUTHORIZED The token is invalid or expired
403 ACCESS_DENIED The token or the author does not have the required permissions
403 DISCORD_CONNECTION_REQUIRED You need a Discord account link to your Steam Account to access to the route
404 SERVER_NOT_FOUND The server does not exist
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"
  • data[]:
    • average: number
    • date: date

Description: Fetch player greats
Ratelimit: 5 per 10s
Required parameters
Name Type Description
serverId number The server id
uuid string The player uuid
Query parameters
Name Type Description Default
from date The start date where you wan't to fetch the statistics ❌
to date The end date where you wan't to fetch the statistics ❌
great number The great value you want to fetch ❌
page number The page number (min: 1) 1
perpage number The limit of elements per page (min: 1, max: 100) 10
search string The search query (only first 50 characters will be considered) ❌
sortby string The column to sort by id
sortdir string The direction to sort by (enum: asc | desc) desc
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_FROM The value doesn't follow the requirements
400 INVALID_GREAT The value doesn't follow the requirements
400 INVALID_PAGE The value doesn't follow the requirements
400 INVALID_PERPAGE The value doesn't follow the requirements
400 INVALID_SEARCH The value doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_SORTBY The value doesn't follow the requirements
400 INVALID_SORTDIR The value doesn't follow the requirements
400 INVALID_TO The value doesn't follow the requirements
401 UNAUTHORIZED The token is invalid or expired
403 ACCESS_DENIED The token or the author does not have the required permissions
403 DISCORD_CONNECTION_REQUIRED You need a Discord account link to your Steam Account to access to the route
404 PLAYER_NOT_FOUND The uuid doesn't refer to an existing player
404 SERVER_NOT_FOUND The server does not exist
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"
  • data[]:
    • id: number
    • targetId: number
    • great: number
    • description: string
    • active: boolean
    • authorId: number
    • authorName: string
    • author:
      • id: number
      • name: string
      • uuid: string
      • firstConnection: date
      • lastConnection: date
      • lastDashboardConnection: date | null
      • accountName: string | null
      • accountType: string
      • accountId: number
      • avatarUrl: string
      • discordUsername: string | null
      • discordDiscriminator: string | null
      • serverId: number
      • roles[]:
        • serverId: number
        • id: number
        • name: string
        • color: string
        • position: number | null
        • categories:
          • id: number
          • name: string
        • deletedAt: date | null
      • language:
        • alpha2: string
        • name: string
    • serverId: number
    • date: date
  • pagination:
    • currentPage: number
    • perPage: number
    • total: number
    • totalFiltered: number
    • totalOnPage: number
    • sort:
      • by: string
      • dir:
    • search: string | null

Description: Set a great as active
Ratelimit: 5 per 10s
Permission: player-greats.manage
Required parameters
Name Type Description
serverId number The server id
id number The great id you wan't to active
Available codes
Status Code Description
200 OK The request has been successfully completed
400 ALREADY_ACTION This great already have an action in progress, you need to wait before doing another action
400 INVALID_SERVER_ID The server id is invalid
401 UNAUTHORIZED The token is invalid or expired
403 ACCESS_DENIED The token or the author does not have the required permissions
403 CANNOT_DO_SELF_ACTION You cannot do this action on yourself if you don't have the administrator permission
403 DISCORD_CONNECTION_REQUIRED You need a Discord account link to your Steam Account to access to the route
404 SERVER_NOT_FOUND The server does not exist
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"

Description: Set a great as inactive
Ratelimit: 5 per 10s
Permission: player-greats.manage
Required parameters
Name Type Description
serverId number The server id
id number The great id you wan't to inactive
Available codes
Status Code Description
200 OK The request has been successfully completed
400 ALREADY_ACTION This great already have an action in progress, you need to wait before doing another action
400 INVALID_SERVER_ID The server id is invalid
401 UNAUTHORIZED The token is invalid or expired
403 ACCESS_DENIED The token or the author does not have the required permissions
403 CANNOT_DO_SELF_ACTION You cannot do this action on yourself if you don't have the administrator permission
403 DISCORD_CONNECTION_REQUIRED You need a Discord account link to your Steam Account to access to the route
404 SERVER_NOT_FOUND The server does not exist
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"