Type Alias ReportsAPI

type ReportsAPI = {
    clearCache: typeof clearCache;
    createReport: typeof createReport;
    getReportOutputs: typeof getReportOutputs;
    getReportStatus: typeof getReportStatus;
}
Index

Properties

clearCache createReport getReportOutputs getReportStatus

Properties

clearCache: typeof clearCache

Clears the cache for reports api requests.

createReport: typeof createReport

Queue a new report request generation.

Param: body

an object with the body content

CreateReportHttpError

getReportOutputs: typeof getReportOutputs

Get the list of the outputs produced so far for the given report request. The outputs are generated asynchronously and are complete only when the status of the report request is 'done' or 'failed' or 'aborted'.

Identifier of the request.

an object with query parameters

GetReportOutputsHttpError

getReportStatus: typeof getReportStatus

Get report request processing status.

Identifier of the request.

GetReportStatusHttpError

Settings

Member Visibility

On This Page

Properties