ScheduledReport is a datatype for information about a scheduled report.

Table: ScheduledReport

ParameterTypeRequiredDefaultDescription
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: Oct 3, 2024
allowedActions[AssetAction]yes Allowed asset actions. This is a preview and subject to changes. See AssetAction.
createdByUser  User who created the report. See User.
creationDatestringyes Date when the report was created.
dashboardDashboardyes The dashboard for which the report was created. See text.
dashboardIdstringyes The unique identifier of the dashboard for which the report was created.
descriptionstringyes Description of the scheduled report.
enabledbooleanyes Whether the scheduled report is enabled.
idstringyes The unique identifier of the scheduled report.
isPasswordDefinedbooleanyes Whether a password is defined for the report.
labels[string]yes Labels attached to the scheduled report.
lastExecutionErrors[string]yes Last errors encountered while generating the scheduled report.
lastExecutionWarnings[string]yes Last warnings encountered while generating the scheduled report.
layoutScheduledReportLayoutyes Layout of the scheduled report. See ScheduledReportLayout.
namestringyes The name of the scheduled report.
parameters[ParameterValue]yes List of parameter value configurations. See ParameterValue.
recipients[string]yes List of recipients who should receive an email with the generated report.
scheduleScheduleyes The schedule by which to run the report. See Schedule.
statusstringyes Status of the latest report execution.
timeIntervalStartstring  Start of the relative time interval for the dashboard.
timeOfLastReportExecutionlong  Unix timestamp for the last report execution. The timestamp only indicates an attempt, not if it was successful.
timeOfNextPlannedReportExecutionlong  Unix timestamp for the next planned report execution.