CreateScheduledReportInput is used to input data for creating a scheduled report.

Table: CreateScheduledReportInput

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: Sep 17, 2024
dashboardIdstringyes The unique identifier of the dashboard for which the report was created.
descriptionstringyes A description of the scheduled report.
enabledbooleanyes Flag indicating whether the scheduled report is enabled.
labels[string]yes Labels attached to the scheduled report.
layoutCreateScheduledReportLayoutInputyes Layout of the scheduled report. See CreateScheduledReportLayoutInput.
namestringyes The name of the scheduled report.
parameters[CreateScheduledReportParameterValueInput]yes A list of parameter value configurations. See CreateScheduledReportParameterValueInput.
passwordstring  The password used to protect any generated reports.
recipients[string]yes A list of recipients who should receive an email with the generated report.
scheduleCreateScheduledReportScheduleInputyes The schedule by which to run the report. See CreateScheduledReportScheduleInput.
timeIntervalFromstring  The start of the relative time interval for the dashboard.
viewNamestringyes The name of the view of the scheduled report.