Function AnalyticsApiFp

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

• analyticsCreateReport:function

  • analyticsCreateReport(rqId?, analyticsReportCreateRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • Optional rqId: string

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

    • Optional analyticsReportCreateRequest: AnalyticsReportCreateRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Creates a analytics report asynchronously and allows to check request status

    Throws

• analyticsGetReports:function

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

  • Receive analytics report

    Parameters

    • Optional endDate: string

      Specify the end date for filtering report data.

    • Optional jobId: number

      Specify job ID

    • Optional projectId: number

      Specify project ID

    • Optional startDate: string

      Specify a start date for filtering report data.

    • Optional taskId: number

      Specify task ID

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method returns analytics report

    Throws