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>;
        statsControllerGetCountryStats: (
            gameServerId?: 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
      OperationId: StatsControllerGetActivityStats

    • statsControllerGetCountryStats: (
          gameServerId?: string[],
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Calculates how many players are from each country. Returns a count per country (ISO3166). Required permissions: READ_PLAYERS
      OperationId: StatsControllerGetCountryStats

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

      Required permissions: READ_PLAYERS
      OperationId: StatsControllerGetCurrencyStats

    • 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
      OperationId: StatsControllerGetEventsCount

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

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

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

      Required permissions: READ_PLAYERS
      OperationId: StatsControllerGetPingStats

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

      Required permissions: READ_PLAYERS
      OperationId: StatsControllerGetPlayerOnlineStats