GearN Server | Rest Api references | Dashboard

Overview

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

Client

Require permission rules dashboard.getAnalytics.selfEnable. See PermissionRules

HTTP

POST /api/rJson/dashboard/client/getAnalytics

Request Headers

Name	Type	Required	Description
Auth-Token	string	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	string	true	The SecretKey in SecretInfo with role must is Player.
Game-Id	string		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	string	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	The selected secret key is missing, wrong, or does not match the current route/game context.
MaxSizeRequestReject	-9	The serialized request payload exceeded the maximum size accepted by the backend.
MaxRequestReject	-8	The backend rejected the request because the current caller exceeded a request-rate limit.
MaxCCUReject	-7	The backend rejected the request because the current concurrent-user/session limit was exceeded.
OperationNotAuthorized	-6	The target operation exists, but the caller is not authorized for the selected role or target resource.
InvalidRequestParameters	-5	The request shape or one or more request-member values are invalid. When available, inspect `invalidMembers` for field-level details.
OperationInvalid	-4	The requested operation code is unknown or is not valid for the selected request type/role.
InternalServerError	-3	The backend hit an unhandled internal failure before producing a valid business response.
OperationNotAllow	-2	The operation is known and the secret key is valid, but the permission rules attached to the current secret key do not allow this operation in the current target context. This usually maps to missing `selfEnable`, `otherSelfEnable`, `serverSelfEnable`, or `adminSelfEnable` permission for the resolved request.
OperationTimeout	-1	The request timed out before a response was received. This code may be synthesized by the SDK timeout layer as well as returned by the backend.
UnknownError	0	The request failed, but no more specific low-level return code was mapped.
Ok	1	The request completed successfully at protocol level and produced a response payload. Callers must still validate the business `errorCode` in that payload.

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