CreateScheduledReportInput is an input datatype for creating a scheduled report. It's used by the createScheduledReport() mutation field.

Table: CreateScheduledReportInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 17, 2024
dashboardIdstringyes Long-TermThe unique identifier of the dashboard for which the report was created.
descriptionstringyes Long-TermA description of the scheduled report.
enabledbooleanyes Long-TermFlag indicating whether the scheduled report is enabled.
labels[string]yes Long-TermLabels attached to the scheduled report.
layoutCreateScheduledReportLayoutInputyes Long-TermLayout of the scheduled report. See CreateScheduledReportLayoutInput.
namestringyes Long-TermThe name of the scheduled report.
parameters[CreateScheduledReportParameterValueInput]yes Long-TermA list of parameter value configurations. See CreateScheduledReportParameterValueInput.
passwordstring  Long-TermThe password used to protect any generated reports.
recipients[string]yes Long-TermA list of recipients who should receive an email with the generated report.
scheduleCreateScheduledReportScheduleInputyes Long-TermThe schedule by which to run the report. See CreateScheduledReportScheduleInput.
timeIntervalFromstring  Long-TermThe start of the relative time interval for the dashboard.
viewNamestringyes Long-TermThe name of the view of the scheduled report.