ScheduledReport is a datatype for information about a scheduled report.

This datatype is used by the createScheduledReport() and updateScheduledReport() mutation fields. To enable or disable a scheduled report, use the enableScheduledReport() and disableScheduledReport() mutations. Use the deleteScheduledReport() mutation to delete a scheduled report.

Table: ScheduledReport

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 14, 2026 
allowedActionsAssetActionyes Short-Term Allowed asset actions. This is a preview and subject to changes. See AssetAction .
createdByUser  Deprecateddeprecated in 1.306User who created the report. See User. This field is deprecated and will be removed at the earliest in version 1.306 It's replaced by createdInfo.
createdInfoAssetCommitMetadata  Long-Termadded in 1.253Metadata related to the creation of the scheduled report. See AssetCommitMetadata.
creationDateStringyes Deprecateddeprecated in 1.306The date when the report was created. This field is deprecated and will be removed at the earliest in version 1.306 It's replaced by createdInfo.
dashboardDashboard  Long-Term The dashboard for which the report was created. See Dashboard.
dashboardIdStringyes Long-Term The unique identifier of the dashboard for which the report was created.
descriptionStringyes Long-Term Description of the scheduled report.
enabledBooleanyes Long-Term Whether the scheduled report is enabled.
idStringyes Long-Term The unique identifier of the scheduled report.
isPasswordDefinedBooleanyes Long-Term Whether a password is defined for the report.
labelsStringyes Long-Term Labels attached to the scheduled report.
lastExecutionErrorsStringyes Long-Term Last errors encountered while generating the scheduled report.
lastExecutionWarningsStringyes Long-Term Last warnings encountered while generating the scheduled report.
layoutScheduledReportLayoutyes Long-Term Layout of the scheduled report. See ScheduledReportLayout.
nameStringyes Long-Term The name of the scheduled report.
packagePackageInstallation  Long-Term The package installation from which this scheduled report was created, if applicable. See PackageInstallation.
packageIdVersionedPackageSpecifier  Long-Term The versioned identifier of the package from which this scheduled report was created, in the format namespace/name@version. VersionedPackageSpecifier is a scalar.
parametersParameterValueyes Long-Term List of parameter value configurations. See ParameterValue.
recipientsStringyes Long-Term List of recipients who should receive an email with the generated report.
resourceStringyes Short-Term The resource identifier for this scheduled report.
scheduleScheduleyes Long-Term The schedule by which to run the report. See Schedule.
statusStringyes Long-Term Status of the latest report execution.
timeIntervalStartString  Long-Term Start of the relative time interval for the dashboard.
timeOfLastExecutionStartLong  Long-Term Unix timestamp for when the last execution was sent to the render service for generation.
timeOfLastReportExecutionLong  Long-Term Unix timestamp for the last report execution. The timestamp only indicates an attempt, not if it was successful.
timeOfNextPlannedReportExecutionLong  Long-Term Unix timestamp for the next planned report execution.
yamlTemplateYAMLyes Preview A YAML-formatted string that describes the scheduled report template used to create or last update this report.