Class AnalyticsApi

AnalyticsApi - object-oriented interface

Export

AnalyticsApi

Hierarchy

BaseAPI
- AnalyticsApi

Index

Constructors

Properties

axios basePath configuration

Methods

analyticsCreateReport analyticsGetReports

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 base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

analyticsCreateReport

analyticsCreateReport(
requestParameters?: AnalyticsApiAnalyticsCreateReportRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: AnalyticsApiAnalyticsCreateReportRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
AnalyticsApi
- Defined in api-client/analytics-api.ts:317

analyticsGetReports

analyticsGetReports(
requestParameters?: AnalyticsApiAnalyticsGetReportsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<AnalyticsReport, any>>
Receive analytics report
Parameters
- requestParameters: AnalyticsApiAnalyticsGetReportsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AnalyticsReport, any>>
Throws
Memberof
AnalyticsApi
- Defined in api-client/analytics-api.ts:329