Function AnalyticsApiFactory

AnalyticsApi - factory interface

Export

AnalyticsApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    analyticsCreateReport(
        requestParameters?: AnalyticsApiAnalyticsCreateReportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    analyticsGetReports(
        requestParameters?: AnalyticsApiAnalyticsGetReportsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnalyticsReport>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    analyticsCreateReport(
        requestParameters?: AnalyticsApiAnalyticsCreateReportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    analyticsGetReports(
        requestParameters?: AnalyticsApiAnalyticsGetReportsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnalyticsReport>;
}
- analyticsCreateReport:function
  - analyticsCreateReport(
    requestParameters?: AnalyticsApiAnalyticsCreateReportRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
    Parameters
    requestParameters: AnalyticsApiAnalyticsCreateReportRequest = {}
    Request parameters.
    
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns AxiosPromise<void>
    Throws
    Defined in api-client/analytics-api.ts:223
- analyticsGetReports:function
  - analyticsGetReports(
    requestParameters?: AnalyticsApiAnalyticsGetReportsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnalyticsReport>
    Receive analytics report
    
    Parameters
    requestParameters: AnalyticsApiAnalyticsGetReportsRequest = {}
    Request parameters.
    
    Optionaloptions: RawAxiosRequestConfig
    Override http request option.
    
    Returns AxiosPromise<AnalyticsReport>
    Throws
    Defined in api-client/analytics-api.ts:233
- Defined in api-client/analytics-api.ts:213

Function AnalyticsApiFactory

Export

Parameters

Returns { analyticsCreateReport( requestParameters?: AnalyticsApiAnalyticsCreateReportRequest, options?: RawAxiosRequestConfig, ): AxiosPromise<void>; analyticsGetReports( requestParameters?: AnalyticsApiAnalyticsGetReportsRequest, options?: RawAxiosRequestConfig, ): AxiosPromise<AnalyticsReport>;}

analyticsCreateReport:function

Parameters

Returns AxiosPromise<void>

Throws

analyticsGetReports:function

Parameters

Returns AxiosPromise<AnalyticsReport>

Throws

Settings