Function AnalyticsApiFactory

Returns {
    analyticsControllerGetActivePlayerCounts(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetActivePlayerCountsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ActiveCountsDTOAPI>;
    analyticsControllerGetActiveUserCounts(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetActiveUserCountsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ActiveCountsDTOAPI>;
    analyticsControllerGetActivityHeatmap(
        eventName?: string,
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetActivityHeatmapPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ActivityHeatmapCellDTOAPI>;
    analyticsControllerGetCountryDetections(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetCountryDetectionsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CountryDetectionDTOAPI>;
    analyticsControllerGetCurrencyFlow(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetCurrencyFlowPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CurrencyFlowPointDTOAPI>;
    analyticsControllerGetCurrencyTimeseries(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetCurrencyTimeseriesPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TimeSeriesPointDTOAPI>;
    analyticsControllerGetDailyPlayerEvents(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetDailyPlayerEventsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DailyPointDTOAPI>;
    analyticsControllerGetEntityCounts(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EntityCountsDTOAPI>;
    analyticsControllerGetEventVolume(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetEventVolumePeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TimeSeriesPointDTOAPI>;
    analyticsControllerGetHourlyActivePlayers(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetHourlyActivePlayersPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TimeSeriesPointDTOAPI>;
    analyticsControllerGetHourlyOrderVolume(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetHourlyOrderVolumePeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RevenueTimeSeriesPointDTOAPI>;
    analyticsControllerGetModerationTimeseries(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetModerationTimeseriesPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ModerationDailyPointDTOAPI>;
    analyticsControllerGetModuleHealth(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetModuleHealthPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ModuleHealthEntryDTOAPI>;
    analyticsControllerGetModuleItemFailureLeaderboard(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetModuleItemFailureLeaderboardPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ModuleItemFailureAggregateDTOAPI>;
    analyticsControllerGetModuleItemTypeSummary(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetModuleItemTypeSummaryPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ModuleItemTypeSummaryEntryDTOAPI>;
    analyticsControllerGetOrderStatusMix(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetOrderStatusMixPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<OrderStatusMixEntryDTOAPI>;
    analyticsControllerGetPingHealth(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPingHealthPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PingHealthPointDTOAPI>;
    analyticsControllerGetPlayerActivityMix(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPlayerActivityMixPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerActivityMixEntryDTOAPI>;
    analyticsControllerGetPlayerKillLeaderboard(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPlayerKillLeaderboardPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerKillLeaderboardEntryDTOAPI>;
    analyticsControllerGetPlayerKpis(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPlayerKpisPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerKpisDTOAPI>;
    analyticsControllerGetPlayerPlaytimeLeaderboard(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPlayerPlaytimeLeaderboardPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerPlaytimeLeaderboardEntryDTOAPI>;
    analyticsControllerGetPlayersOnlineTimeseries(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPlayersOnlineTimeseriesPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TimeSeriesPointDTOAPI>;
    analyticsControllerGetSessionLengthDistribution(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetSessionLengthDistributionPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SessionLengthBucketDTOAPI>;
    analyticsControllerGetShopCategoryRevenue(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopCategoryRevenuePeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryRevenueDTOAPI>;
    analyticsControllerGetShopCustomerSegments(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopCustomerSegmentsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCustomerSegmentsDTOAPI>;
    analyticsControllerGetShopDeadStock(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopDeadStockPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopDeadStockDTOAPI>;
    analyticsControllerGetShopKpis(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopKpisPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopKpisDTOAPI>;
    analyticsControllerGetShopRecentOrders(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopRecentOrdersPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopRecentOrderDTOAPI>;
    analyticsControllerGetShopRevenueHeatmap(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopRevenueHeatmapPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopRevenueHeatmapCellDTOAPI>;
    analyticsControllerGetTopBuyers(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetTopBuyersPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopTopBuyerDTOAPI>;
    analyticsControllerGetTopEventNames(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetTopEventNamesPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LeaderboardEntryDTOAPI>;
    analyticsControllerGetTopListings(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetTopListingsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopTopListingDTOAPI>;
    analyticsControllerGetTopModulesByVolume(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetTopModulesByVolumePeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LeaderboardEntryDTOAPI>;
    analyticsControllerGetTopServers(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetTopServersPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LeaderboardEntryDTOAPI>;
}

• analyticsControllerGetActivePlayerCounts: function

  • analyticsControllerGetActivePlayerCounts(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetActivePlayerCountsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ActiveCountsDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetActivePlayerCounts

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ActiveCountsDTOAPI>

    Throws

• analyticsControllerGetActiveUserCounts: function

  • analyticsControllerGetActiveUserCounts(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetActiveUserCountsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ActiveCountsDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetActiveUserCounts

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ActiveCountsDTOAPI>

    Throws

• analyticsControllerGetActivityHeatmap: function

  • analyticsControllerGetActivityHeatmap(
        eventName?: string,
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetActivityHeatmapPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ActivityHeatmapCellDTOAPI>

    24 hour × 7 day-of-week event grid. Pass eventName to filter to a single event type (e.g. shop-order-created). Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetActivityHeatmap

    Parameters

    • OptionaleventName: string
    • OptionalstartDate: string
    • OptionalendDate: string
    • OptionalgameServerId: string
    • Optionalperiod: AnalyticsControllerGetActivityHeatmapPeriodEnum
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ActivityHeatmapCellDTOAPI>

    Throws

• analyticsControllerGetCountryDetections: function

  • analyticsControllerGetCountryDetections(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetCountryDetectionsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CountryDetectionDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetCountryDetections

    Parameters

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

      Override http request option.

    Returns AxiosPromise<CountryDetectionDTOAPI>

    Throws

• analyticsControllerGetCurrencyFlow: function

  • analyticsControllerGetCurrencyFlow(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetCurrencyFlowPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CurrencyFlowPointDTOAPI>

    Total currency added vs deducted per time bucket, from currency-added and currency-deducted events. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetCurrencyFlow

    Parameters

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

      Override http request option.

    Returns AxiosPromise<CurrencyFlowPointDTOAPI>

    Throws

• analyticsControllerGetCurrencyTimeseries: function

  • analyticsControllerGetCurrencyTimeseries(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetCurrencyTimeseriesPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TimeSeriesPointDTOAPI>

    Aggregate currency values from player-sync-snapshot events, bucketed by time. gameServerId is optional. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetCurrencyTimeseries

    Parameters

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

      Override http request option.

    Returns AxiosPromise<TimeSeriesPointDTOAPI>

    Throws

• analyticsControllerGetDailyPlayerEvents: function

  • analyticsControllerGetDailyPlayerEvents(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetDailyPlayerEventsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DailyPointDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetDailyPlayerEvents

    Parameters

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

      Override http request option.

    Returns AxiosPromise<DailyPointDTOAPI>

    Throws

• analyticsControllerGetEntityCounts: function

  • analyticsControllerGetEntityCounts(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EntityCountsDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetEntityCounts

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<EntityCountsDTOAPI>

    Throws

• analyticsControllerGetEventVolume: function

  • analyticsControllerGetEventVolume(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetEventVolumePeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TimeSeriesPointDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetEventVolume

    Parameters

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

      Override http request option.

    Returns AxiosPromise<TimeSeriesPointDTOAPI>

    Throws

• analyticsControllerGetHourlyActivePlayers: function

  • analyticsControllerGetHourlyActivePlayers(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetHourlyActivePlayersPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TimeSeriesPointDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetHourlyActivePlayers

    Parameters

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

      Override http request option.

    Returns AxiosPromise<TimeSeriesPointDTOAPI>

    Throws

• analyticsControllerGetHourlyOrderVolume: function

  • analyticsControllerGetHourlyOrderVolume(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetHourlyOrderVolumePeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RevenueTimeSeriesPointDTOAPI>

    Returns orders + revenue bucketed to match the selected period. Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: AnalyticsControllerGetHourlyOrderVolume

    Parameters

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

      Override http request option.

    Returns AxiosPromise<RevenueTimeSeriesPointDTOAPI>

    Throws

• analyticsControllerGetModerationTimeseries: function

  • analyticsControllerGetModerationTimeseries(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetModerationTimeseriesPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ModerationDailyPointDTOAPI>

    Daily counts of player-banned and player-unbanned events. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetModerationTimeseries

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ModerationDailyPointDTOAPI>

    Throws

• analyticsControllerGetModuleHealth: function

  • analyticsControllerGetModuleHealth(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetModuleHealthPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ModuleHealthEntryDTOAPI>

    Normalized 0-1 scores across five dimensions per top module for radar visualization. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetModuleHealth

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ModuleHealthEntryDTOAPI>

    Throws

• analyticsControllerGetModuleItemFailureLeaderboard: function

  • analyticsControllerGetModuleItemFailureLeaderboard(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetModuleItemFailureLeaderboardPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ModuleItemFailureAggregateDTOAPI>

    Unified failure leaderboard across all module-item types (hooks, crons, commands, shop actions). Each row carries a type discriminator alongside runs, failures, and failure rate. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetModuleItemFailureLeaderboard

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ModuleItemFailureAggregateDTOAPI>

    Throws

• analyticsControllerGetModuleItemTypeSummary: function

  • analyticsControllerGetModuleItemTypeSummary(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetModuleItemTypeSummaryPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ModuleItemTypeSummaryEntryDTOAPI>

    Returns one row per module-item type (hook, cron, command, shopAction) with total runs and failures. Zero-filled when no events exist so the response shape is stable. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetModuleItemTypeSummary

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ModuleItemTypeSummaryEntryDTOAPI>

    Throws

• analyticsControllerGetOrderStatusMix: function

  • analyticsControllerGetOrderStatusMix(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetOrderStatusMixPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<OrderStatusMixEntryDTOAPI>

    Counts by status sourced from Postgres shopOrder.status (authoritative current state). Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: AnalyticsControllerGetOrderStatusMix

    Parameters

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

      Override http request option.

    Returns AxiosPromise<OrderStatusMixEntryDTOAPI>

    Throws

• analyticsControllerGetPingHealth: function

  • analyticsControllerGetPingHealth(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPingHealthPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PingHealthPointDTOAPI>

    p50 and p95 of meta.ping from player-sync-snapshot events, bucketed by time. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetPingHealth

    Parameters

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

      Override http request option.

    Returns AxiosPromise<PingHealthPointDTOAPI>

    Throws

• analyticsControllerGetPlayerActivityMix: function

  • analyticsControllerGetPlayerActivityMix(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPlayerActivityMixPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerActivityMixEntryDTOAPI>

    Counts per event_name across the player-activity whitelist (chat, kills, deaths, inventory, shop orders, roles, currency). Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetPlayerActivityMix

    Parameters

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

      Override http request option.

    Returns AxiosPromise<PlayerActivityMixEntryDTOAPI>

    Throws

• analyticsControllerGetPlayerKillLeaderboard: function

  • analyticsControllerGetPlayerKillLeaderboard(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPlayerKillLeaderboardPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerKillLeaderboardEntryDTOAPI>

    Top players by K/D ratio — kills from entity-killed, deaths from player-death. Minimum 5 combined events. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetPlayerKillLeaderboard

    Parameters

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

      Override http request option.

    Returns AxiosPromise<PlayerKillLeaderboardEntryDTOAPI>

    Throws

• analyticsControllerGetPlayerKpis: function

  • analyticsControllerGetPlayerKpis(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPlayerKpisPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerKpisDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetPlayerKpis

    Parameters

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

      Override http request option.

    Returns AxiosPromise<PlayerKpisDTOAPI>

    Throws

• analyticsControllerGetPlayerPlaytimeLeaderboard: function

  • analyticsControllerGetPlayerPlaytimeLeaderboard(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPlayerPlaytimeLeaderboardPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerPlaytimeLeaderboardEntryDTOAPI>

    Ranks players by total connected time within the selected period. Sums meta.sessionMinutes from player-disconnected events. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetPlayerPlaytimeLeaderboard

    Parameters

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

      Override http request option.

    Returns AxiosPromise<PlayerPlaytimeLeaderboardEntryDTOAPI>

    Throws

• analyticsControllerGetPlayersOnlineTimeseries: function

  • analyticsControllerGetPlayersOnlineTimeseries(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetPlayersOnlineTimeseriesPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TimeSeriesPointDTOAPI>

    Aggregate player-sync-snapshot events with online=true, bucketed by time. gameServerId is optional; omit it for domain-wide aggregation. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetPlayersOnlineTimeseries

    Parameters

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

      Override http request option.

    Returns AxiosPromise<TimeSeriesPointDTOAPI>

    Throws

• analyticsControllerGetSessionLengthDistribution: function

  • analyticsControllerGetSessionLengthDistribution(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetSessionLengthDistributionPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SessionLengthBucketDTOAPI>

    Buckets meta.sessionMinutes from player-disconnected events into fixed ranges. Always returns six buckets, zero-filled where there is no data. Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetSessionLengthDistribution

    Parameters

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

      Override http request option.

    Returns AxiosPromise<SessionLengthBucketDTOAPI>

    Throws

• analyticsControllerGetShopCategoryRevenue: function

  • analyticsControllerGetShopCategoryRevenue(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopCategoryRevenuePeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryRevenueDTOAPI>

    Hybrid query: ClickHouse revenue per listing combined with Postgres listing→category mapping. Listings without a category are grouped as "Uncategorized". Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: AnalyticsControllerGetShopCategoryRevenue

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ShopCategoryRevenueDTOAPI>

    Throws

• analyticsControllerGetShopCustomerSegments: function

  • analyticsControllerGetShopCustomerSegments(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopCustomerSegmentsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCustomerSegmentsDTOAPI>

    Classifies distinct buyers in the window by purchase history and recency. Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: AnalyticsControllerGetShopCustomerSegments

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ShopCustomerSegmentsDTOAPI>

    Throws

• analyticsControllerGetShopDeadStock: function

  • analyticsControllerGetShopDeadStock(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopDeadStockPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopDeadStockDTOAPI>

    Listings that have not sold in the last 30 days. Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: AnalyticsControllerGetShopDeadStock

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ShopDeadStockDTOAPI>

    Throws

• analyticsControllerGetShopKpis: function

  • analyticsControllerGetShopKpis(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopKpisPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopKpisDTOAPI>

    Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: AnalyticsControllerGetShopKpis

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ShopKpisDTOAPI>

    Throws

• analyticsControllerGetShopRecentOrders: function

  • analyticsControllerGetShopRecentOrders(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopRecentOrdersPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopRecentOrderDTOAPI>

    Sourced from Postgres shopOrder table with joined listing and player display names. Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: AnalyticsControllerGetShopRecentOrders

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ShopRecentOrderDTOAPI>

    Throws

• analyticsControllerGetShopRevenueHeatmap: function

  • analyticsControllerGetShopRevenueHeatmap(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetShopRevenueHeatmapPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopRevenueHeatmapCellDTOAPI>

    Sums totalPrice from shop-order-created events by hour and day-of-week. Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: AnalyticsControllerGetShopRevenueHeatmap

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ShopRevenueHeatmapCellDTOAPI>

    Throws

• analyticsControllerGetTopBuyers: function

  • analyticsControllerGetTopBuyers(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetTopBuyersPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopTopBuyerDTOAPI>

    Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: AnalyticsControllerGetTopBuyers

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ShopTopBuyerDTOAPI>

    Throws

• analyticsControllerGetTopEventNames: function

  • analyticsControllerGetTopEventNames(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetTopEventNamesPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LeaderboardEntryDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetTopEventNames

    Parameters

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

      Override http request option.

    Returns AxiosPromise<LeaderboardEntryDTOAPI>

    Throws

• analyticsControllerGetTopListings: function

  • analyticsControllerGetTopListings(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetTopListingsPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopTopListingDTOAPI>

    Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: AnalyticsControllerGetTopListings

    Parameters

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

      Override http request option.

    Returns AxiosPromise<ShopTopListingDTOAPI>

    Throws

• analyticsControllerGetTopModulesByVolume: function

  • analyticsControllerGetTopModulesByVolume(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetTopModulesByVolumePeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LeaderboardEntryDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetTopModulesByVolume

    Parameters

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

      Override http request option.

    Returns AxiosPromise<LeaderboardEntryDTOAPI>

    Throws

• analyticsControllerGetTopServers: function

  • analyticsControllerGetTopServers(
        startDate?: string,
        endDate?: string,
        gameServerId?: string,
        period?: AnalyticsControllerGetTopServersPeriodEnum,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LeaderboardEntryDTOAPI>

    Required permissions: READ_EVENTS
    OperationId: AnalyticsControllerGetTopServers

    Parameters

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

      Override http request option.

    Returns AxiosPromise<LeaderboardEntryDTOAPI>

    Throws