Type Alias Meta

Define the request metadata. It includes priority, deadline and future settings on execution policy of the request.

type Meta = {
    exportDeadline?: string;
    outputTtl?: string;
}
Index

Properties

exportDeadline? outputTtl?

Properties

exportDeadline?: string

The maximum interval, starting from the time the API request is received, within which a report must be produced, past this interval the report generation fails. The default value is 10 minutes, the maximum allowed value is 4 hours. The recommended value for standard apps and exports (image, data, sheet) is 10 minutes, for larger apps or reports using composition or file based templates (Excel, PixelPerfect, HTML...) it should be set to 1 hour.

outputTtl?: string

Time to live of the final result artifacts in ISO8601 duration format. After that duration the request and underlying output files will not be guaranteed to be available. Default is 1 hour.

Settings

Member Visibility

On This Page

Properties