IDashboardExportRawOptions
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Options for exporting dashboard to raw data
export interface IDashboardExportRawOptions extends IDashboardExportTimezoneOptions
Extends: IDashboardExportTimezoneOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) CSV delimiter to use for the exported file. | ||
number | (ALPHA) (Optional) Override the default export result polling timeout (in milliseconds). |
Property details
IDashboardExportRawOptions.delimiterpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
CSV delimiter to use for the exported file.
delimiter?: string;
IDashboardExportRawOptions.timeoutpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Override the default export result polling timeout (in milliseconds).
timeout?: number;
Remarks
If not specified, there is still a default timeout applied. You can use this to make the timeout more aggressive or more relaxed than the default. We recommend not setting this lower than 5 seconds as it would mean only one attempt would be made.