Function StatsApiFactory

Returns {
    statsControllerGetActivityStats(
        timeType: StatsControllerGetActivityStatsTimeTypeEnum,
        dataType: StatsControllerGetActivityStatsDataTypeEnum,
        gameServerId?: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<StatsOutputDTOAPI>;
    statsControllerGetCountryStats(
        gameServerId?: string[],
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<StatsOutputDTOAPI>;
    statsControllerGetCurrencyStats(
        gameServerId: string,
        playerId?: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<StatsOutputDTOAPI>;
    statsControllerGetEventsCount(
        eventName: StatsControllerGetEventsCountEventNameEnum,
        bucketStep: StatsControllerGetEventsCountBucketStepEnum,
        sumBy?: StatsControllerGetEventsCountSumByEnum[],
        gameServerId?: string,
        moduleId?: string,
        playerId?: string,
        userId?: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<StatsOutputDTOAPI>;
    statsControllerGetLatencyStats(
        gameServerId: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<StatsOutputDTOAPI>;
    statsControllerGetPingStats(
        gameServerId: string,
        playerId: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<StatsOutputDTOAPI>;
    statsControllerGetPlayerOnlineStats(
        gameServerId?: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<StatsOutputDTOAPI>;
}

• statsControllerGetActivityStats:function

  • statsControllerGetActivityStats(
        timeType: StatsControllerGetActivityStatsTimeTypeEnum,
        dataType: StatsControllerGetActivityStatsDataTypeEnum,
        gameServerId?: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<StatsOutputDTOAPI>

    Throws

• statsControllerGetCountryStats:function

  • statsControllerGetCountryStats(
        gameServerId?: string[],
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<StatsOutputDTOAPI>

    Throws

• statsControllerGetCurrencyStats:function

  • statsControllerGetCurrencyStats(
        gameServerId: string,
        playerId?: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<StatsOutputDTOAPI>

  • Required permissions: READ_PLAYERS
    OperationId: StatsControllerGetCurrencyStats

    Parameters

    • gameServerId: string
    • OptionalplayerId: string
    • OptionalstartDate: string
    • OptionalendDate: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<StatsOutputDTOAPI>

    Throws

• statsControllerGetEventsCount:function

  • statsControllerGetEventsCount(
        eventName: StatsControllerGetEventsCountEventNameEnum,
        bucketStep: StatsControllerGetEventsCountBucketStepEnum,
        sumBy?: StatsControllerGetEventsCountSumByEnum[],
        gameServerId?: string,
        moduleId?: string,
        playerId?: string,
        userId?: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<StatsOutputDTOAPI>

    Throws

• statsControllerGetLatencyStats:function

  • statsControllerGetLatencyStats(
        gameServerId: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<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 AxiosPromise<StatsOutputDTOAPI>

    Throws

• statsControllerGetPingStats:function

  • statsControllerGetPingStats(
        gameServerId: string,
        playerId: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<StatsOutputDTOAPI>

  • Required permissions: READ_PLAYERS
    OperationId: StatsControllerGetPingStats

    Parameters

    • gameServerId: string
    • playerId: string
    • OptionalstartDate: string
    • OptionalendDate: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<StatsOutputDTOAPI>

    Throws

• statsControllerGetPlayerOnlineStats:function

  • statsControllerGetPlayerOnlineStats(
        gameServerId?: string,
        startDate?: string,
        endDate?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<StatsOutputDTOAPI>

  • Required permissions: READ_PLAYERS
    OperationId: StatsControllerGetPlayerOnlineStats

    Parameters

    • OptionalgameServerId: string
    • OptionalstartDate: string
    • OptionalendDate: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<StatsOutputDTOAPI>

    Throws