Function AnalyticsApiAxiosParamCreator

  • AnalyticsApi - axios parameter creator

    Parameters

    Returns {
        analyticsCreateReport: ((rqId?, analyticsReportCreateRequest?, options?) => Promise<RequestArgs>);
        analyticsGetReports: ((endDate?, jobId?, projectId?, startDate?, taskId?, options?) => Promise<RequestArgs>);
    }

    • analyticsCreateReport: ((rqId?, analyticsReportCreateRequest?, options?) => Promise<RequestArgs>)
        • (rqId?, analyticsReportCreateRequest?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

          Summary

          Creates a analytics report asynchronously and allows to check request status

          Throws

    • analyticsGetReports: ((endDate?, jobId?, projectId?, startDate?, taskId?, options?) => Promise<RequestArgs>)
        • (endDate?, jobId?, projectId?, startDate?, taskId?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

          Summary

          Method returns analytics report

          Throws

    Export

Generated using TypeDoc