Function StatsApiAxiosParamCreator

StatsApi - axios parameter creator

  • Parameters

    • Optionalconfiguration: Configuration

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

    • statsControllerGetActivityStats: ((timeType: StatsControllerGetActivityStatsTimeTypeEnum, dataType: StatsControllerGetActivityStatsDataTypeEnum, gameServerId?: string, startDate?: string, endDate?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_PLAYERS

      Get activity stats

    • statsControllerGetCurrencyStats: ((gameServerId: string, playerId: string, startDate?: string, endDate?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_PLAYERS

      Get currency stats

        • (gameServerId, playerId, startDate?, endDate?, options?): Promise<RequestArgs>
        • Parameters

          • gameServerId: string
          • playerId: string
          • OptionalstartDate: string
          • OptionalendDate: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • statsControllerGetEventsCount: ((eventName: StatsControllerGetEventsCountEventNameEnum, bucketStep: StatsControllerGetEventsCountBucketStepEnum, sumBy?: StatsControllerGetEventsCountSumByEnum[], gameServerId?: string, moduleId?: string, playerId?: string, userId?: string, startDate?: string, endDate?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      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

      Get event count over time

    • statsControllerGetLatencyStats: ((gameServerId: string, startDate?: string, endDate?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      The roundtrip time for reachability tests between Takaro and the game server

      Get latency stats

        • (gameServerId, startDate?, endDate?, options?): Promise<RequestArgs>
        • Parameters

          • gameServerId: string
          • OptionalstartDate: string
          • OptionalendDate: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • statsControllerGetPingStats: ((gameServerId: string, playerId: string, startDate?: string, endDate?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_PLAYERS

      Get ping stats

        • (gameServerId, playerId, startDate?, endDate?, options?): Promise<RequestArgs>
        • Parameters

          • gameServerId: string
          • playerId: string
          • OptionalstartDate: string
          • OptionalendDate: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • statsControllerGetPlayerOnlineStats: ((gameServerId?: string, startDate?: string, endDate?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_PLAYERS

      Get player online stats

        • (gameServerId?, startDate?, endDate?, options?): Promise<RequestArgs>
        • Parameters

          • OptionalgameServerId: string
          • OptionalstartDate: string
          • OptionalendDate: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>