Class AnalyticsApi

AnalyticsApi - object-oriented interface

Export

AnalyticsApi

Hierarchy

BaseAPI
- AnalyticsApi

Index

Constructors

Properties

axios basePath configuration

Methods

analyticsControllerGetShopAnalytics

Constructors

constructor

new AnalyticsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): AnalyticsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns AnalyticsApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

analyticsControllerGetShopAnalytics

analyticsControllerGetShopAnalytics(
    gameServerIds?: string[],
    period?: AnalyticsControllerGetShopAnalyticsPeriodEnum,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopAnalyticsOutputDTOAPI, any>>
Retrieve comprehensive analytics for shop performance across selected game servers Required permissions: MANAGE_SHOP_LISTINGS
OperationId: AnalyticsControllerGetShopAnalytics
Parameters
- OptionalgameServerIds: string[]
- Optionalperiod: AnalyticsControllerGetShopAnalyticsPeriodEnum
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopAnalyticsOutputDTOAPI, any>>
Throws
Memberof
AnalyticsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:14659