Function StatsApiFactory

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

  • Required permissions: READ_PLAYERS

    Parameters

    • timeType: StatsControllerGetActivityStatsTimeTypeEnum
    • dataType: StatsControllerGetActivityStatsDataTypeEnum
    • OptionalgameServerId: string
    • OptionalstartDate: string
    • OptionalendDate: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<StatsOutputDTOAPI>

    Summary

    Get activity stats

    Throws

• statsControllerGetCurrencyStats:function

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

  • Required permissions: READ_PLAYERS

    Parameters

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

      Override http request option.

    Returns AxiosPromise<StatsOutputDTOAPI>

    Summary

    Get currency stats

    Throws

• statsControllerGetEventsCount:function

  • statsControllerGetEventsCount(eventName, bucketStep, sumBy?, gameServerId?, moduleId?, playerId?, userId?, startDate?, endDate?, options?): 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

    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>

    Summary

    Get event count over time

    Throws

• statsControllerGetLatencyStats:function

  • statsControllerGetLatencyStats(gameServerId, startDate?, endDate?, options?): AxiosPromise<StatsOutputDTOAPI>

  • 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 AxiosPromise<StatsOutputDTOAPI>

    Summary

    Get latency stats

    Throws

• statsControllerGetPingStats:function

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

  • Required permissions: READ_PLAYERS

    Parameters

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

      Override http request option.

    Returns AxiosPromise<StatsOutputDTOAPI>

    Summary

    Get ping stats

    Throws

• statsControllerGetPlayerOnlineStats:function

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

  • Required permissions: READ_PLAYERS

    Parameters

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

      Override http request option.

    Returns AxiosPromise<StatsOutputDTOAPI>

    Summary

    Get player online stats

    Throws