Function AnalyticsApiFp

AnalyticsApi - functional programming interface

Export

  • AnalyticsApiFp(
        configuration?: Configuration,
    ): {
        analyticsCreateReport(
            rqId?: string,
            analyticsReportCreateRequest?: AnalyticsReportCreateRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        analyticsGetReports(
            endDate?: string,
            jobId?: number,
            projectId?: number,
            startDate?: string,
            taskId?: number,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AnalyticsReport>,
        >;
    }

    Parameters

    Returns {
        analyticsCreateReport(
            rqId?: string,
            analyticsReportCreateRequest?: AnalyticsReportCreateRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        analyticsGetReports(
            endDate?: string,
            jobId?: number,
            projectId?: number,
            startDate?: string,
            taskId?: number,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AnalyticsReport>,
        >;
    }

    • analyticsCreateReport:function
      • analyticsCreateReport(
            rqId?: string,
            analyticsReportCreateRequest?: AnalyticsReportCreateRequest,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

        Parameters

        • OptionalrqId: string

          The report creation request id. Can be specified to check the report creation status.

        • OptionalanalyticsReportCreateRequest: AnalyticsReportCreateRequest
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

        Throws

    • analyticsGetReports:function
      • analyticsGetReports(
            endDate?: string,
            jobId?: number,
            projectId?: number,
            startDate?: string,
            taskId?: number,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AnalyticsReport>,
        >

        Receive analytics report

        Parameters

        • OptionalendDate: string

          Specify the end date for filtering report data.

        • OptionaljobId: number

          Specify job ID

        • OptionalprojectId: number

          Specify project ID

        • OptionalstartDate: string

          Specify a start date for filtering report data.

        • OptionaltaskId: number

          Specify task ID

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<AnalyticsReport>,
        >

        Throws

Settings

Member Visibility