GearN Server | Rest Api references | Dashboard

Retrieve system analytics data including traffic, platforms, memory usage, and countries.

Require permission rules masterAdmin.getAnalytics.selfEnable. See PermissionRules

HTTP

POST /api/rJson/masterAdmin/client/getAnalytics

Request Headers

Name	Required	Description
Auth-Token	true	A token used to authenticate the user. It is issued after successful login from the client type authenticate (e.g., loginByAccount, loginWithCustomId, etc.) or when an admin logs in via the GearN Dashboard. This token identifies the request sender and determines their access level.
Secret-Key	true	The SecretKey in SecretInfo with role must is Player.
Game-Id		Optional if the gameId in the SecretInfo use in headers Secret-Key has assign a valid value, if not, let unique identifier of the game this request is targeting.
Content-Type	true	application/json

Request Body

Code	Type	Description
timestamp	number	Unix timestamp used for filtering analytics or logs. (from 0)
analyticsItem	boolean	Include general analytics metrics.
country	boolean	Include country-based analytics breakdown.
requestComplete	boolean	Include completed request data in analytics.
operationSystem	boolean	Include platform or OS-based analytics breakdown.
databaseSystem	boolean	DatabaseSystem parameter.
logDatabaseSystem	boolean	LogDatabaseSystem parameter.
cost	boolean	Cost parameter.
monthlyCost	boolean	MonthlyCost parameter.

Response Body

200 Ok

Code	Type	Required	Description
returnCode	ReturnCode	true	Additional metadata that can be attached to any request. Especially useful when working with advanced features such as EventCallbackScript. See ReturnCode
debugMessage	string		A developer-oriented message that provides additional context useful for debugging and internal logging. This field is not intended for end-users and may include stack traces, validation failures, or internal error diagnostics.
invalidRequestParameters	InvalidMember[]		Just had data when the returnCode is InvalidRequestParameters.A list of members that failed validation or could not be processed during the request. Each entry typically includes identifying information and an error reason. This is useful for partial success scenarios where some members are accepted and others are rejected. See InvalidMember
parameters	ResponseData		Just had data when the returnCode is Ok. A dynamic set of key-value pairs included in the response to provide additional context or metadata. These parameters may vary depending on the operation and typically contain optional fields such as timestamps, identifiers, or computed values relevant to the result. See ResponseData

ReturnCode

Name	Code	Description
SecretInvalid	-10	Secret token is invalid (removed, expired or does not contains).
MaxSizeRequestReject	-9	Request rejected due to exceeding maximum allowed size.
MaxRequestReject	-8	Request rejected because the number of requests has exceeded the allowed limit per user or IP or exceeds the total number of pending requests the server is waiting to process..
MaxCCUReject	-7	Connection rejected due to exceeding the allowed CCU (Concurrent Users).
OperationNotAuthorized	-6	You are not authorized to perform this operation. Possibly due to missing or invalid token, or insufficient permissions.
InvalidRequestParameters	-5	Request parameters are invalid or missing.
OperationInvalid	-4	The requested operation is invalid or not supported.
InternalServerError	-3	Internal server error. Could be due to an unhandled exception or logic failure.
OperationNotAllow	-2	This operation is not allowed in the current context.
OperationTimeout	-1	The operation timed out. No response received within the expected time.
UnknownError	0	An unknown error occurred. The cause could not be determined.
Ok	1	Success. The operation completed successfully and returned a valid result.

ResponseData

Code	Type	Description
errorCode	ErrorCode	A string that represents the status of the operation. It indicates whether the request was successful or failed due to a specific error condition. See ErrorCode
analyticsItem	AnalyticsItemResponseData	AnalyticsItem used in GetAnalyticsResponseData. See AnalyticsItemResponseData
country	CountryResponseData[]	Country used in GetAnalyticsResponseData. See CountryResponseData
operationSystem	OperationSystemResponseData	OperationSystem used in GetAnalyticsResponseData. See OperationSystemResponseData
requestComplete	RequestCompleteResponseData[]	RequestComplete used in GetAnalyticsResponseData. See RequestCompleteResponseData
databaseSystem	DatabaseSystemResponseData	DatabaseSystem used in GetAnalyticsResponseData. See DatabaseSystemResponseData
logDatabaseSystem	DatabaseSystemResponseData	LogDatabaseSystem used in GetAnalyticsResponseData. See DatabaseSystemResponseData
cost	CostResponseData	Cost used in GetAnalyticsResponseData. See CostResponseData
monthlyCost	CostResponseData	MonthlyCost used in GetAnalyticsResponseData. See CostResponseData

AnalyticsItemResponseData