Class StatsApi

StatsApi - object-oriented interface

Export

StatsApi

Hierarchy

BaseAPI
- StatsApi

Index

Constructors

constructor

new StatsApi(configuration?, basePath?, axios?): 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, dataType, gameServerId?, startDate?, endDate?, options?): Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Required permissions: READ_PLAYERS
Parameters
- timeType: StatsControllerGetActivityStatsTimeTypeEnum
- dataType: StatsControllerGetActivityStatsDataTypeEnum
- OptionalgameServerId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Summary
Get activity stats

Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22782

statsControllerGetCountryStats

statsControllerGetCountryStats(gameServerId?, options?): Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Calculates how many players are from each country. Returns a count per country (ISO3166). Required permissions: READ_PLAYERS
Parameters
- OptionalgameServerId: string[]
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Summary
Get statistics about the countries of the players

Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22803

statsControllerGetCurrencyStats

statsControllerGetCurrencyStats(gameServerId, playerId?, startDate?, endDate?, options?): Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Required permissions: READ_PLAYERS
Parameters
- gameServerId: string
- OptionalplayerId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Summary
Get currency stats

Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22820

statsControllerGetEventsCount

statsControllerGetEventsCount(eventName, bucketStep, sumBy?, gameServerId?, moduleId?, playerId?, userId?, startDate?, endDate?, options?): Promise<AxiosResponse<StatsOutputDTOAPI, any>>
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
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, any>>
Summary
Get event count over time

Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22848

statsControllerGetLatencyStats

statsControllerGetLatencyStats(gameServerId, startDate?, endDate?, options?): Promise<AxiosResponse<StatsOutputDTOAPI, any>>
The roundtrip time for reachability tests between Takaro and the game server
Parameters
- gameServerId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Summary
Get latency stats

Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22886

statsControllerGetPingStats

statsControllerGetPingStats(gameServerId, playerId, startDate?, endDate?, options?): Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Required permissions: READ_PLAYERS
Parameters
- gameServerId: string
- playerId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Summary
Get ping stats

Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22908

statsControllerGetPlayerOnlineStats

statsControllerGetPlayerOnlineStats(gameServerId?, startDate?, endDate?, options?): Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Required permissions: READ_PLAYERS
Parameters
- OptionalgameServerId: string
- OptionalstartDate: string
- OptionalendDate: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>
Summary
Get player online stats

Throws
Memberof
StatsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22930

Class StatsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StatsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

statsControllerGetActivityStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>

Summary

Throws

Memberof

statsControllerGetCountryStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>

Summary

Throws

Memberof

statsControllerGetCurrencyStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>

Summary

Throws

Memberof

statsControllerGetEventsCount

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>

Summary

Throws

Memberof

statsControllerGetLatencyStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>

Summary

Throws

Memberof

statsControllerGetPingStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>

Summary

Throws

Memberof

statsControllerGetPlayerOnlineStats

Parameters

Returns Promise<AxiosResponse<StatsOutputDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration