Documentation - KB RolePlay

Description: Fetch all sessions from a filter

Ratelimit: 5 per 10s

Permission: player-sessions.read-all

You will be able to fetch only the sessions of the players you have access to (with the player-sessions.read scope)

You needs to have the staff-statistics.read permission to filter by staffTime

Required parameters

Name	Type	Description
serverId	number	The server id
filter	string	The filter you wan't to fetch the sessions

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	❌
active	boolean	If you wan't to fetch only active sessions	true

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_ACTIVE`	The value doesn't follow the requirements
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[]:
- id: number
- playerId: number
- player:
  - 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
  - badges[]:
    - id: number
    - category:
      - id: number
      - name: string
      - deletedAt: date | null
    - iconPath: string
    - fullIconPath: string
    - value: number
    - deletedAt: date | null
    - translations?:
      - name: string | null
      - description: string | null
    - addedAt: date
    - revokedAt: date | null
- filter: string
- fromDate: date
- endDate: date | null
- duration: number

Description: Fetch player sessions tops

Ratelimit: 5 per 10s

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	❌
limit	number	The limit of the data length (min: `1`, max: `50`)	10

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_LIMIT`	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[]:
- player:
  - 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
  - badges[]:
    - id: number
    - category:
      - id: number
      - name: string
      - deletedAt: date | null
    - iconPath: string
    - fullIconPath: string
    - value: number
    - deletedAt: date | null
    - translations?:
      - name: string | null
      - description: string | null
    - addedAt: date
    - revokedAt: date | null
- duration: number

Description: Fetch your session

Ratelimit: 5 per 10s

Permission: player-sessions.read-me

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 sessions	0
to	date	The end date where you wan't to fetch the sessions	Current date

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[]:
- id: number
- playerId: number
- filter: string
- fromDate: date
- endDate: date | null
- duration: number

Description: Fetch your presence pourcentage

Ratelimit: 5 per 10s

Permission: player-sessions.read-me

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 presence pourcentage	0
to	date	The end date where you wan't to fetch the presence pourcentage	Current date

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:
- play: number
- staff: number | null

Description: Fetch player sessions

Ratelimit: 5 per 10s

Scope: player-sessions.read

You needs to have the staff-statistics.read permission to filter by staffTime

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 sessions	0
to	date	The end date where you wan't to fetch the sessions	Current date
filters	string	The filters you wan't to apply to the sessions (separated by a comma)	All filters

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_FILTERS`	The value doesn't follow the requirements
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	`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
- playerId: number
- filter: string
- fromDate: date
- endDate: date | null
- duration: number

Description: Fetch player sessions duration by filter

Ratelimit: 5 per 10s

Scope: player-sessions.read

You needs to have the staff-statistics.read permission to filter by staffTime

Required parameters

Name	Type	Description
serverId	number	The server id
uuid	string	The player uuid
filter	string	The filter you wan't to get the global duration

Query parameters

Name	Type	Description	Default
from	date	The start date where you wan't to fetch the duration	0
to	date	The end date where you wan't to fetch the duration	Current date

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	`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:
- duration: number

Description: Fetch player sessions presence pourcentage

Ratelimit: 5 per 10s

Scope: player-sessions.read

You needs to have the staff-statistics.read permission to fetch the staff presence pourcentage

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 presence pourcentage	0
to	date	The end date where you wan't to fetch the presence pourcentage	Current date

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	`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:
- play: number
- staff: number | null

Description: Fetch player sessions duration (in seconds)

Ratelimit: 5 per 10s

Scope: player-sessions.read

You needs to have the staff-statistics.read permission to consider the staffTime filter

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	0
to	date	The end date where you wan't to fetch the statistics	Current date

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	`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:
- duration: number

Description: Fetch player sessions types

Ratelimit: 5 per 10s

Required parameters

Name	Type	Description
serverId	number	The server id

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	`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: string[]

GET /api/v2/:serverId/players/sessions/:filter

GET /api/v2/:serverId/players/sessions/top

GET /api/v2/:serverId/me/sessions

GET /api/v2/:serverId/me/sessions/presence

GET /api/v2/:serverId/players/:uuid/sessions

GET /api/v2/:serverId/players/:uuid/sessions/:filter

GET /api/v2/:serverId/players/:uuid/sessions/presence

GET /api/v2/:serverId/players/:uuid/sessions/statistics

GET /api/v2/:serverId/sessions/filters