Class StatsApi

StatsApi - object-oriented interface

Export

StatsApi

Hierarchy

BaseAPI
- StatsApi

Index

Constructors

constructor

new StatsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): StatsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns StatsApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

statsControllerGetActivityStats

statsControllerGetActivityStats(
    timeType: StatsControllerGetActivityStatsTimeTypeEnum,
    dataType: StatsControllerGetActivityStatsDataTypeEnum,
    gameServerId?: string,
    startDate?: string,
    endDate?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<StatsOutputDTOAPI>>
Required permissions: READ_PLAYERS
OperationId: StatsControllerGetActivityStats
Parameters
- timeType: StatsControllerGetActivityStatsTimeTypeEnum
- dataType: StatsControllerGetActivityStatsDataTypeEnum
- OptionalgameServerId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI>>
Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23133

statsControllerGetCountryStats

statsControllerGetCountryStats(
gameServerId?: string[],
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<StatsOutputDTOAPI>>
Calculates how many players are from each country. Returns a count per country (ISO3166). Required permissions: READ_PLAYERS
OperationId: StatsControllerGetCountryStats
Parameters
- OptionalgameServerId: string[]
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI>>
Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23154

statsControllerGetCurrencyStats

statsControllerGetCurrencyStats(
    gameServerId: string,
    playerId?: string,
    startDate?: string,
    endDate?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<StatsOutputDTOAPI>>
Required permissions: READ_PLAYERS
OperationId: StatsControllerGetCurrencyStats
Parameters
- gameServerId: string
- OptionalplayerId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI>>
Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23171

statsControllerGetEventsCount

statsControllerGetEventsCount(
    eventName: StatsControllerGetEventsCountEventNameEnum,
    bucketStep: StatsControllerGetEventsCountBucketStepEnum,
    sumBy?: StatsControllerGetEventsCountSumByEnum[],
    gameServerId?: string,
    moduleId?: string,
    playerId?: string,
    userId?: string,
    startDate?: string,
    endDate?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<StatsOutputDTOAPI>>
Calculates how many times an event type has occured over bucketStep time. Supports different filters and can return multiple series at a time. Required permissions: READ_PLAYERS
OperationId: StatsControllerGetEventsCount
Parameters
- eventName: StatsControllerGetEventsCountEventNameEnum
- bucketStep: StatsControllerGetEventsCountBucketStepEnum
- OptionalsumBy: StatsControllerGetEventsCountSumByEnum[]
- OptionalgameServerId: string
- OptionalmoduleId: string
- OptionalplayerId: string
- OptionaluserId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI>>
Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23199

statsControllerGetLatencyStats

statsControllerGetLatencyStats(
    gameServerId: string,
    startDate?: string,
    endDate?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<StatsOutputDTOAPI>>
The roundtrip time for reachability tests between Takaro and the game server
OperationId: StatsControllerGetLatencyStats
Parameters
- gameServerId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI>>
Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23237

statsControllerGetPingStats

statsControllerGetPingStats(
    gameServerId: string,
    playerId: string,
    startDate?: string,
    endDate?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<StatsOutputDTOAPI>>
Required permissions: READ_PLAYERS
OperationId: StatsControllerGetPingStats
Parameters
- gameServerId: string
- playerId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI>>
Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23259

statsControllerGetPlayerOnlineStats

statsControllerGetPlayerOnlineStats(
    gameServerId?: string,
    startDate?: string,
    endDate?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<StatsOutputDTOAPI>>
Required permissions: READ_PLAYERS
OperationId: StatsControllerGetPlayerOnlineStats
Parameters
- OptionalgameServerId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI>>
Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23281

Class StatsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StatsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

statsControllerGetActivityStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI>>

Throws

Memberof

statsControllerGetCountryStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI>>

Throws

Memberof

statsControllerGetCurrencyStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI>>

Throws

Memberof

statsControllerGetEventsCount

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI>>

Throws

Memberof

statsControllerGetLatencyStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI>>

Throws

Memberof

statsControllerGetPingStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI>>

Throws

Memberof

statsControllerGetPlayerOnlineStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration