Akan.js

Admin

admin

Admin is a person who manages the system, that has a data managent and system monitoring authority.

Admin

Full

8 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
accountId Account ID	String	Required	property	-	null	text:searchcustom validate	-	Account ID Description
password Password	String	Optional	property	-	null	minlength 8	-	Password Description
roles Roles	[String]	Required	property	-	[]	-	manageradminsuperAdmin	Roles Description
lastLoginAt Last Login	Date	Required	property	-	[function]	-	-	Last Login Description

Banner

banner

Banner is a temporary notice informations that is displayed on the top or in front of the page

Banner

Full

13 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
category Category	String	Optional	property	-	null	-	-	Category of banner, displayed on the top
title Title	String	Optional	property	-	null	-	-	Title of banner, displayed on the top
content Content	String	Optional	property	-	null	-	-	Content of banner, displayed on the bottom
image Image	File	Optional	property	reference	null	-	-	Image of banner, displayed on the center
href Href	String	Required	property	-	null	-	-	Href of banner, link to other page
target Target	String	Required	property	-	_self	-	_blank_self	Target configuration of <a> tag in banner
from From	Date	Required	property	-	"2026-05-31T09:24:44.713Z"	-	-	Start date of banner
to To	Date	Optional	property	-	null	-	-	End date of banner
status Status	String	Required	property	-	active	-	activedisplaying	Status of banner

File

file

File is a blob data that is stored in the database, such as image, document or video

File

Full

15 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
filename File Name	String	Required	property	-	null	-	-	Name of the file with extension
mimetype Mime Type	String	Required	property	-	null	-	-	Mime type of the file
encoding Encoding	String	Required	property	-	null	-	-	Encoding of the file
imageSize Image Size	[Int]	Required	property	-	[0,0]	-	-	Size of the image as width and height tuple in pixel
url Url	String	Optional	property	-		-	-	Url of the file
abstractData Abstract Data	String	Optional	property	-	null	-	-	Abstract blurred encoded data of image files to preview
size Size	Int	Required	property	-	0	-	-	File size in bytes
origin Origin	String	Optional	property	-	null	-	-	Origin source url of the file
lastModifiedAt Last Modified At	Date	Required	property	-	[function]	-	-	Last modified date of the file
progress Progress	Int	Optional	property	-	null	-	-	Upload progress of the file, uploading status files are used only
status Status	String	Required	property	-	uploading	-	activeuploading	Status of the file

Notification

notification

Notification is a group of informations that is sent or going to be sent to the user. It is used for the user to be notified of the event, and the events can be accumulated and summarized by groups.

Notification

Full

11 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
token Token	String	Optional	property	-	null	-	-	Token of the notification
title Title	String	Required	property	-	null	-	-	Title of the notification
content Content	String	Required	property	-	null	-	-	Content of the notification
field Field	String	Optional	property	-	null	-	-	Field of the notification
image Image	File	Optional	property	reference	null	-	-	Image of the notification
type Type	String	Required	property	-	token	-	topictoken	Type of the notification
level Level	String	Required	property	-	notice	-	actionRequirednoticeessentialsuggestionadvertise	Level of the notification

PrivFile

privFile

Private file is a server-only blob that is stored outside public asset serving.

PrivFile

Full

13 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
alias Alias	String	Required	property	-	null	-	-	Display alias for the private file
filename File Name	String	Optional	hidden	-	null	-	-	Name of the file with extension
mimetype Mime Type	String	Required	property	-	null	-	-	Mime type of the private file
encoding Encoding	String	Required	property	-	null	-	-	Encoding of the private file
privatePath Private Path	String	Optional	hidden	-	null	-	-	Private path of the private file
size Size	Int	Required	property	-	0	-	-	Private file size in bytes
lastModifiedAt Last Modified At	Date	Required	property	-	[function]	-	-	Last modified date of the private file
progress Progress	Int	Optional	property	-	null	-	-	Upload progress of the private file, uploading status files are used only
status Status	String	Required	property	-	uploading	-	activeuploading	Status of the private file

Setting

setting

Setting is a system setting that is controll and manage the metrics of the system and the service.

Setting

Full

5 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
resignupDays Re-signup Days	Int	Required	property	-	0	-	-	The number of days to allow re-signup

Summary

summary

Summary is a group of system and service metrics that is used for the system to be monitored and managed.

Summary

Full

15 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
type Type	String	Required	property	-	non-periodic	-	non-periodicactivehourlydailyweeklymonthly	Type of summary, e.g. periodic, non-periodic...
at At	Date	Required	property	-	[function]	-	-	The time when the summary is created
status Status	String	Required	property	-	archived	-	activearchived	Status of the summary
prepareUser Prepare User	Int	Required	property	-	0	-	-	Number of users with preparation
activeUser Active User	Int	Required	property	-	0	-	-	Number of active users
dormantUser Dormant User	Int	Required	property	-	0	-	-	Number of dormant users
restrictedUser Restricted User	Int	Required	property	-	0	-	-	Number of users with restrictions
hau HAU	Int	Required	property	-	0	-	-	Hourly Active User
dau DAU	Int	Required	property	-	0	-	-	Daily Active User
wau WAU	Int	Required	property	-	0	-	-	Weekly Active User
mau MAU	Int	Required	property	-	0	-	-	Monthly Active User

User

user

User is an public information of the user who uses the service. It can be displayed to other users.

User

Full

28 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
nickname Nickname	String	Optional	property	-		maxlength 12	-	Nickname of the user that is displayed to other users
image Image	File	Optional	property	reference	null	-	-	Profile image of the user
images Images	[File]	Required	property	reference	[]	-	-	Profile images of the user
appliedImages Applied Images	[File]	Required	property	reference	[]	-	-	Applied images of the user
name Name	String	Optional	hiddenselect:false	-	null	-	-	Name of the user
agreePolicies Agree Policies	[String]	Optional	hiddenselect:false	-	[]	-	-	Agreed policies of the user
discord Discord	Any	Optional	hiddenselect:false	-	{}	-	-	Discord information of the user
accountId Account ID	String	Optional	hiddenselect:false	-	null	-	-	Account ID of the user
password Password	String	Optional	hiddenselect:false	-	null	-	-	Password of the user
phone Phone	String	Optional	hiddenselect:false	-	null	-	-	Phone number of the user
notiInfo Noti Info	NotiInfo	Optional	hiddenselect:false	-	null	-	-	Notification information of the user
imageNum Image Number	Int	Optional	hiddenselect:false	-	0	-	-	Number of images of the user
encourageInfo Encourage Info	EncourageInfo	Optional	hiddenselect:false	-	[function]	-	-	Encourage information of the user
restrictInfo Restrict Info	RestrictInfo	Optional	hiddenselect:false	-	null	-	-	Restrict information of the user
leaveInfo Leave Info	LeaveInfo	Optional	hiddenselect:false	-	null	-	-	Leave information of the user
verifies Verifies	[String]	Required	property	-	[]	-	naverkakaogithubgoogleapplefacebookwalletpasswordphoneemail	Verification information of the user
roles Roles	[String]	Required	property	-	["user"]	-	rootadminuserbusinessguest	Authorized roles of the user
playing Playing	[String]	Required	property	-	[]	-	-	Services that the user is playing
isOnline Is Online	Boolean	Required	property	-	true	-	-	Online status of the user
lastLoginAt Last Login At	Date	Required	property	-	[function]	-	-	Latest login time of the user
joinAt Join At	Date	Optional	property	-	null	-	-	Join date of the user
profileStatus Profile Status	String	Required	property	-	prepare	-	activeprepareappliedapprovedreappliedfeaturedreservedrejected	Profile approval status of the user
badgeCount Badge Count	Int	Required	property	-	0	-	-	Badge count of the user
status Status	String	Required	property	-	prepare	-	prepareactivedormantrestricted	Status of the user

AccessLog

accessLog

Access log information

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
period Period	Int	Required	property	-	0	-	-	Time period
countryCode Country Code	String	Optional	property	-	null	-	-	ISO country code
countryName Country Name	String	Optional	property	-	null	-	-	Name of the country
city City	String	Optional	property	-	null	-	-	City name
postal Postal	Int	Optional	property	-	null	-	-	Postal code
location Location	Coordinate	Optional	property	-	null	-	-	Geographic location
ipv4 IPv4	String	Optional	property	-	null	-	-	IPv4 address
state State	String	Optional	property	-	null	-	-	State or province
osName OS Name	String	Optional	property	-	null	-	-	Operating system name
osVersion OS Version	String	Optional	property	-	null	-	-	Operating system version
browserName Browser Name	String	Optional	property	-	null	-	-	Web browser name
browserVersion Browser Version	String	Optional	property	-	null	-	-	Web browser version
mobileModel Mobile Model	String	Optional	property	-	null	-	-	Mobile device model
mobileVendor Mobile Vendor	String	Optional	property	-	null	-	-	Mobile device vendor
deviceType Device Type	String	Optional	property	-	null	-	-	Type of device
at At	Date	Required	property	-	[function]	-	-	Access time

AccessStat

accessStat

Access statistics information

Key	Type	Required	Field Type	Relation	Constraints	Enum	Description
request Request	Int	Required	property	-	-	-	Number of requests
device Device	Int	Required	property	-	-	-	Number of devices
ip IP	Int	Required	property	-	-	-	Number of unique IPs
country Country	Int	Required	property	-	-	-	Number of countries

AccessToken

accessToken

Access token for authentication

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
jwt JWT	String	Required	property	-	null	-	-	JSON Web Token
refreshToken Refresh Token	String	Optional	property	-	null	-	-	Refresh token for token renewal
expiresAt Expires At	Date	Optional	property	-	null	-	-	Access token expiration time

Coordinate

coordinate

Geographic coordinate information

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
type Type	String	Required	property	-	Point	-	Point	Coordinate type
coordinates Coordinates	[Float]	Required	property	-	[0,0]	-	-	Longitude and latitude values
altitude Altitude	Float	Required	property	-	0	-	-	Altitude in meters

EncourageInfo

encourageInfo

Encourage Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
journey Journey	String	Required	property	-	welcome	-	welcomewaitingfirstJoinjoinedleavingleavedreturningreturned	Journey
journeyAt Journey At	Date	Required	property	-	[function]	-	-	Journey At
inquiry Inquiry	String	Required	property	-	welcome	-	welcomepayablewaitPaypaidmorePayablewaitMorePayinquiredconcernedconcernedPayableconcernedWaitPayashedvipkicked	Inquiry
inquiryAt Inquiry At	Date	Required	property	-	[function]	-	-	Inquiry At

ExternalLink

externalLink

External Link

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
type Type	String	Required	property	-	null	-	websitetwitterdiscordtelegraminstagramfacebookyoutubegithubmediumlinkedinreddittwitchvimeoweibowikipediaappemailother	Type
url URL	String	Required	property	-	null	-	-	URL

FileMeta

fileMeta

File Meta

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
fileId File ID	ID	Optional	property	-	null	-	-	File ID
lastModifiedAt Last Modified At	Date	Required	property	-	null	-	-	Last Modified At
size Size	Int	Required	property	-	null	-	-	Size

LeaveInfo

leaveInfo

Leave Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
type Type	String	Required	property	-	noReply	-	noReplycomebackunsatisfiedother	Type
reason Reason	String	Optional	property	-	null	-	-	Reason
satisfaction Satisfaction	Int	Optional	property	-	null	min 1max 5	-	Satisfaction
voc VOC	String	Optional	property	-	null	-	-	VOC
at At	Date	Required	property	-	[function]	-	-	At

NotiInfo

notiInfo

Noti Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
setting Setting	String	Required	property	-	normal	-	disagreefewernormalblock	Setting
pauseUntil Pause Until	Date	Required	property	-	[function]	-	-	Pause Until
deviceTokens Device Tokens	[String]	Required	property	-	[]	-	-	Device Tokens

RestrictInfo

restrictInfo

Restrict Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
until Until	Date	Required	property	-	null	-	-	Until
reason Reason	String	Required	property	-	null	-	-	Reason

SearchResult

searchResult

Search result information

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
docs Documents	Any	Required	property	-	[]	-	-	Search result documents
skip Skip	Int	Required	property	-	0	-	-	Number of results skipped
limit Limit	Int	Required	property	-	20	-	-	Maximum number of results
sort Sort	String	Required	property	-	notImplemented	-	-	Sort order
total Total	Int	Required	property	-	0	-	-	Total number of results

ServiceReview

serviceReview

Service Review

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
score Score	Int	Required	property	-	0	min 0	-	Score
comment Comment	String	Optional	property	-	null	-	-	Comment

Key	Ref Name	Type	Used By
adminRole	adminRole	String	admin.rolesadmin.rolesadmin.roles
bannerStatus	bannerStatus	String	banner.statusbanner.statusbanner.status
bannerTarget	bannerTarget	String	banner.targetbanner.targetbanner.targetbanner.target
coordinateType	coordinateType	String	coordinate.type
fileStatus	fileStatus	String	file.statusfile.statusfile.statusprivFile.statusprivFile.statusprivFile.status
inquiry	inquiry	String	encourageInfo.inquiry
journey	journey	String	encourageInfo.journey
leaveType	leaveType	String	leaveInfo.type
linkType	linkType	String	externalLink.type
notificationType	notificationType	String	notification.typenotification.typenotification.typenotification.type
notiLevel	notiLevel	String	notification.levelnotification.levelnotification.levelnotification.level
notiSetting	notiSetting	String	notiInfo.setting
periodType	periodType	String	summary.typesummary.typesummary.type
profileStatus	profileStatus	String	user.profileStatususer.profileStatususer.profileStatus
responsive	responsive	String	-
ssoType	ssoType	String	-
summaryStatus	summaryStatus	String	summary.statussummary.status
userRole	userRole	String	user.rolesuser.roles
userStatus	userStatus	String	user.statususer.statususer.status
verify	verify	String	user.verifiesuser.verifies

Admin

admin

Admin is a person who manages the system, that has a data managent and system monitoring authority.

Admin

Full

8 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
accountId Account ID	String	Required	property	-	null	text:searchcustom validate	-	Account ID Description
password Password	String	Optional	property	-	null	minlength 8	-	Password Description
roles Roles	[String]	Required	property	-	[]	-	manageradminsuperAdmin	Roles Description
lastLoginAt Last Login	Date	Required	property	-	[function]	-	-	Last Login Description

Banner

banner

Banner is a temporary notice informations that is displayed on the top or in front of the page

Banner

Full

13 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
category Category	String	Optional	property	-	null	-	-	Category of banner, displayed on the top
title Title	String	Optional	property	-	null	-	-	Title of banner, displayed on the top
content Content	String	Optional	property	-	null	-	-	Content of banner, displayed on the bottom
image Image	File	Optional	property	reference	null	-	-	Image of banner, displayed on the center
href Href	String	Required	property	-	null	-	-	Href of banner, link to other page
target Target	String	Required	property	-	_self	-	_blank_self	Target configuration of <a> tag in banner
from From	Date	Required	property	-	"2026-05-31T09:24:44.713Z"	-	-	Start date of banner
to To	Date	Optional	property	-	null	-	-	End date of banner
status Status	String	Required	property	-	active	-	activedisplaying	Status of banner

File

file

File is a blob data that is stored in the database, such as image, document or video

File

Full

15 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
filename File Name	String	Required	property	-	null	-	-	Name of the file with extension
mimetype Mime Type	String	Required	property	-	null	-	-	Mime type of the file
encoding Encoding	String	Required	property	-	null	-	-	Encoding of the file
imageSize Image Size	[Int]	Required	property	-	[0,0]	-	-	Size of the image as width and height tuple in pixel
url Url	String	Optional	property	-		-	-	Url of the file
abstractData Abstract Data	String	Optional	property	-	null	-	-	Abstract blurred encoded data of image files to preview
size Size	Int	Required	property	-	0	-	-	File size in bytes
origin Origin	String	Optional	property	-	null	-	-	Origin source url of the file
lastModifiedAt Last Modified At	Date	Required	property	-	[function]	-	-	Last modified date of the file
progress Progress	Int	Optional	property	-	null	-	-	Upload progress of the file, uploading status files are used only
status Status	String	Required	property	-	uploading	-	activeuploading	Status of the file

Notification

notification

Notification is a group of informations that is sent or going to be sent to the user. It is used for the user to be notified of the event, and the events can be accumulated and summarized by groups.

Notification

Full

11 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
token Token	String	Optional	property	-	null	-	-	Token of the notification
title Title	String	Required	property	-	null	-	-	Title of the notification
content Content	String	Required	property	-	null	-	-	Content of the notification
field Field	String	Optional	property	-	null	-	-	Field of the notification
image Image	File	Optional	property	reference	null	-	-	Image of the notification
type Type	String	Required	property	-	token	-	topictoken	Type of the notification
level Level	String	Required	property	-	notice	-	actionRequirednoticeessentialsuggestionadvertise	Level of the notification

PrivFile

privFile

Private file is a server-only blob that is stored outside public asset serving.

PrivFile

Full

13 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
alias Alias	String	Required	property	-	null	-	-	Display alias for the private file
filename File Name	String	Optional	hidden	-	null	-	-	Name of the file with extension
mimetype Mime Type	String	Required	property	-	null	-	-	Mime type of the private file
encoding Encoding	String	Required	property	-	null	-	-	Encoding of the private file
privatePath Private Path	String	Optional	hidden	-	null	-	-	Private path of the private file
size Size	Int	Required	property	-	0	-	-	Private file size in bytes
lastModifiedAt Last Modified At	Date	Required	property	-	[function]	-	-	Last modified date of the private file
progress Progress	Int	Optional	property	-	null	-	-	Upload progress of the private file, uploading status files are used only
status Status	String	Required	property	-	uploading	-	activeuploading	Status of the private file

Setting

setting

Setting is a system setting that is controll and manage the metrics of the system and the service.

Setting

Full

5 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
resignupDays Re-signup Days	Int	Required	property	-	0	-	-	The number of days to allow re-signup

Summary

summary

Summary is a group of system and service metrics that is used for the system to be monitored and managed.

Summary

Full

15 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
type Type	String	Required	property	-	non-periodic	-	non-periodicactivehourlydailyweeklymonthly	Type of summary, e.g. periodic, non-periodic...
at At	Date	Required	property	-	[function]	-	-	The time when the summary is created
status Status	String	Required	property	-	archived	-	activearchived	Status of the summary
prepareUser Prepare User	Int	Required	property	-	0	-	-	Number of users with preparation
activeUser Active User	Int	Required	property	-	0	-	-	Number of active users
dormantUser Dormant User	Int	Required	property	-	0	-	-	Number of dormant users
restrictedUser Restricted User	Int	Required	property	-	0	-	-	Number of users with restrictions
hau HAU	Int	Required	property	-	0	-	-	Hourly Active User
dau DAU	Int	Required	property	-	0	-	-	Daily Active User
wau WAU	Int	Required	property	-	0	-	-	Weekly Active User
mau MAU	Int	Required	property	-	0	-	-	Monthly Active User

User

user

User is an public information of the user who uses the service. It can be displayed to other users.

User

Full

28 fields

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
id ID	ID	Required	property	-	null	-	-	Unique ID value
createdAt CreatedAt	Date	Required	property	-	null	-	-	Data created time
updatedAt UpdatedAt	Date	Required	property	-	null	-	-	Data updated time
removedAt RemovedAt	Date	Optional	property	-	null	-	-	Data removed time
nickname Nickname	String	Optional	property	-		maxlength 12	-	Nickname of the user that is displayed to other users
image Image	File	Optional	property	reference	null	-	-	Profile image of the user
images Images	[File]	Required	property	reference	[]	-	-	Profile images of the user
appliedImages Applied Images	[File]	Required	property	reference	[]	-	-	Applied images of the user
name Name	String	Optional	hiddenselect:false	-	null	-	-	Name of the user
agreePolicies Agree Policies	[String]	Optional	hiddenselect:false	-	[]	-	-	Agreed policies of the user
discord Discord	Any	Optional	hiddenselect:false	-	{}	-	-	Discord information of the user
accountId Account ID	String	Optional	hiddenselect:false	-	null	-	-	Account ID of the user
password Password	String	Optional	hiddenselect:false	-	null	-	-	Password of the user
phone Phone	String	Optional	hiddenselect:false	-	null	-	-	Phone number of the user
notiInfo Noti Info	NotiInfo	Optional	hiddenselect:false	-	null	-	-	Notification information of the user
imageNum Image Number	Int	Optional	hiddenselect:false	-	0	-	-	Number of images of the user
encourageInfo Encourage Info	EncourageInfo	Optional	hiddenselect:false	-	[function]	-	-	Encourage information of the user
restrictInfo Restrict Info	RestrictInfo	Optional	hiddenselect:false	-	null	-	-	Restrict information of the user
leaveInfo Leave Info	LeaveInfo	Optional	hiddenselect:false	-	null	-	-	Leave information of the user
verifies Verifies	[String]	Required	property	-	[]	-	naverkakaogithubgoogleapplefacebookwalletpasswordphoneemail	Verification information of the user
roles Roles	[String]	Required	property	-	["user"]	-	rootadminuserbusinessguest	Authorized roles of the user
playing Playing	[String]	Required	property	-	[]	-	-	Services that the user is playing
isOnline Is Online	Boolean	Required	property	-	true	-	-	Online status of the user
lastLoginAt Last Login At	Date	Required	property	-	[function]	-	-	Latest login time of the user
joinAt Join At	Date	Optional	property	-	null	-	-	Join date of the user
profileStatus Profile Status	String	Required	property	-	prepare	-	activeprepareappliedapprovedreappliedfeaturedreservedrejected	Profile approval status of the user
badgeCount Badge Count	Int	Required	property	-	0	-	-	Badge count of the user
status Status	String	Required	property	-	prepare	-	prepareactivedormantrestricted	Status of the user

AccessLog

accessLog

Access log information

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
period Period	Int	Required	property	-	0	-	-	Time period
countryCode Country Code	String	Optional	property	-	null	-	-	ISO country code
countryName Country Name	String	Optional	property	-	null	-	-	Name of the country
city City	String	Optional	property	-	null	-	-	City name
postal Postal	Int	Optional	property	-	null	-	-	Postal code
location Location	Coordinate	Optional	property	-	null	-	-	Geographic location
ipv4 IPv4	String	Optional	property	-	null	-	-	IPv4 address
state State	String	Optional	property	-	null	-	-	State or province
osName OS Name	String	Optional	property	-	null	-	-	Operating system name
osVersion OS Version	String	Optional	property	-	null	-	-	Operating system version
browserName Browser Name	String	Optional	property	-	null	-	-	Web browser name
browserVersion Browser Version	String	Optional	property	-	null	-	-	Web browser version
mobileModel Mobile Model	String	Optional	property	-	null	-	-	Mobile device model
mobileVendor Mobile Vendor	String	Optional	property	-	null	-	-	Mobile device vendor
deviceType Device Type	String	Optional	property	-	null	-	-	Type of device
at At	Date	Required	property	-	[function]	-	-	Access time

AccessStat

accessStat

Access statistics information

Key	Type	Required	Field Type	Relation	Constraints	Enum	Description
request Request	Int	Required	property	-	-	-	Number of requests
device Device	Int	Required	property	-	-	-	Number of devices
ip IP	Int	Required	property	-	-	-	Number of unique IPs
country Country	Int	Required	property	-	-	-	Number of countries

AccessToken

accessToken

Access token for authentication

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
jwt JWT	String	Required	property	-	null	-	-	JSON Web Token
refreshToken Refresh Token	String	Optional	property	-	null	-	-	Refresh token for token renewal
expiresAt Expires At	Date	Optional	property	-	null	-	-	Access token expiration time

Coordinate

coordinate

Geographic coordinate information

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
type Type	String	Required	property	-	Point	-	Point	Coordinate type
coordinates Coordinates	[Float]	Required	property	-	[0,0]	-	-	Longitude and latitude values
altitude Altitude	Float	Required	property	-	0	-	-	Altitude in meters

EncourageInfo

encourageInfo

Encourage Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
journey Journey	String	Required	property	-	welcome	-	welcomewaitingfirstJoinjoinedleavingleavedreturningreturned	Journey
journeyAt Journey At	Date	Required	property	-	[function]	-	-	Journey At
inquiry Inquiry	String	Required	property	-	welcome	-	welcomepayablewaitPaypaidmorePayablewaitMorePayinquiredconcernedconcernedPayableconcernedWaitPayashedvipkicked	Inquiry
inquiryAt Inquiry At	Date	Required	property	-	[function]	-	-	Inquiry At

ExternalLink

externalLink

External Link

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
type Type	String	Required	property	-	null	-	websitetwitterdiscordtelegraminstagramfacebookyoutubegithubmediumlinkedinreddittwitchvimeoweibowikipediaappemailother	Type
url URL	String	Required	property	-	null	-	-	URL

FileMeta

fileMeta

File Meta

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
fileId File ID	ID	Optional	property	-	null	-	-	File ID
lastModifiedAt Last Modified At	Date	Required	property	-	null	-	-	Last Modified At
size Size	Int	Required	property	-	null	-	-	Size

LeaveInfo

leaveInfo

Leave Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
type Type	String	Required	property	-	noReply	-	noReplycomebackunsatisfiedother	Type
reason Reason	String	Optional	property	-	null	-	-	Reason
satisfaction Satisfaction	Int	Optional	property	-	null	min 1max 5	-	Satisfaction
voc VOC	String	Optional	property	-	null	-	-	VOC
at At	Date	Required	property	-	[function]	-	-	At

NotiInfo

notiInfo

Noti Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
setting Setting	String	Required	property	-	normal	-	disagreefewernormalblock	Setting
pauseUntil Pause Until	Date	Required	property	-	[function]	-	-	Pause Until
deviceTokens Device Tokens	[String]	Required	property	-	[]	-	-	Device Tokens

RestrictInfo

restrictInfo

Restrict Info

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
until Until	Date	Required	property	-	null	-	-	Until
reason Reason	String	Required	property	-	null	-	-	Reason

SearchResult

searchResult

Search result information

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
docs Documents	Any	Required	property	-	[]	-	-	Search result documents
skip Skip	Int	Required	property	-	0	-	-	Number of results skipped
limit Limit	Int	Required	property	-	20	-	-	Maximum number of results
sort Sort	String	Required	property	-	notImplemented	-	-	Sort order
total Total	Int	Required	property	-	0	-	-	Total number of results

ServiceReview

serviceReview

Service Review

Key	Type	Required	Field Type	Relation	Default	Constraints	Enum	Description
score Score	Int	Required	property	-	0	min 0	-	Score
comment Comment	String	Optional	property	-	null	-	-	Comment