ScheduledReport is a
datatype for information about a scheduled report.
Table: ScheduledReport
| Parameter | Type | Required | Default | Stability | Description |
|---|---|---|---|---|---|
| Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
| Table last updated: Mar 19, 2025 | |||||
allowedActions | [AssetAction] | yes | Preview | Allowed asset actions. This is a preview and subject to changes. See AssetAction. | |
createdBy | User | Long-Term | User who created the report. See User. | ||
creationDate | string | yes | Long-Term | Date when the report was created. | |
Dashboard | Dashboard | yes | Long-Term | The dashboard for which the report was created. See text. | |
dashboardId | string | yes | Long-Term | The unique identifier of the dashboard for which the report was created. | |
description | string | yes | Long-Term | Description of the scheduled report. | |
enabled | boolean | yes | Long-Term | Whether the scheduled report is enabled. | |
id | string | yes | Long-Term | The unique identifier of the scheduled report. | |
isPasswordDefined | boolean | yes | Long-Term | Whether a password is defined for the report. | |
labels | [string] | yes | Long-Term | Labels attached to the scheduled report. | |
lastExecutionErrors | [string] | yes | Long-Term | Last errors encountered while generating the scheduled report. | |
lastExecutionWarnings | [string] | yes | Long-Term | Last warnings encountered while generating the scheduled report. | |
layout | ScheduledReportLayout | yes | Long-Term | Layout of the scheduled report. See ScheduledReportLayout. | |
name | string | yes | Long-Term | The name of the scheduled report. | |
parameters | [ParameterValue] | yes | Long-Term | List of parameter value configurations. See ParameterValue. | |
recipients | [string] | yes | Long-Term | List of recipients who should receive an email with the generated report. | |
resource | string | yes | Short-Term | The resource identifier for this scheduled report. | |
schedule | Schedule | yes | Long-Term | The schedule by which to run the report. See Schedule. | |
Status | string | yes | Long-Term | Status of the latest report execution. | |
timeIntervalStart | string | Long-Term | Start of the relative time interval for the dashboard. | ||
timeOfLastReportExecution | long | Long-Term | Unix timestamp for the last report execution. The timestamp only indicates an attempt, not if it was successful. | ||
timeOfNextPlannedReportExecution | long | Long-Term | Unix timestamp for the next planned report execution. | ||