Class AnalyticsApi

AnalyticsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- AnalyticsApi

Index

Constructors

Properties

axios basePath configuration

Methods

analyticsCreateReport analyticsGetReports

Constructors

constructor

new AnalyticsApi(configuration?, basePath?, axios?): AnalyticsApi
Parameters
- Optional configuration: 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?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: AnalyticsApiAnalyticsCreateReportRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Creates a analytics report asynchronously and allows to check request status

Throws

Memberof
AnalyticsApi
- Defined in api-client/analytics-api.ts:313

analyticsGetReports

analyticsGetReports(requestParameters?, options?): Promise<AxiosResponse<AnalyticsReport, any>>
Receive analytics report
Parameters
- requestParameters: AnalyticsApiAnalyticsGetReportsRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AnalyticsReport, any>>

Summary
Method returns analytics report

Throws

Memberof
AnalyticsApi
- Defined in api-client/analytics-api.ts:325

Generated using TypeDoc