CreateScheduledReportInput
is used to input data for creating a scheduled report.
Table: CreateScheduledReportInput
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: Sep 17, 2024 | |||||
dashboardId | string | yes | Long-Term | The unique identifier of the dashboard for which the report was created. | |
description | string | yes | Long-Term | A description of the scheduled report. | |
enabled | boolean | yes | Long-Term | Flag indicating whether the scheduled report is enabled. | |
labels | [string] | yes | Long-Term | Labels attached to the scheduled report. | |
layout | CreateScheduledReportLayoutInput | yes | Long-Term | Layout of the scheduled report. See CreateScheduledReportLayoutInput . | |
name | string | yes | Long-Term | The name of the scheduled report. | |
parameters | [CreateScheduledReportParameterValueInput ] | yes | Long-Term | A list of parameter value configurations. See CreateScheduledReportParameterValueInput . | |
password | string | Long-Term | The password used to protect any generated reports. | ||
recipients | [string] | yes | Long-Term | A list of recipients who should receive an email with the generated report. | |
schedule | CreateScheduledReportScheduleInput | yes | Long-Term | The schedule by which to run the report. See CreateScheduledReportScheduleInput . | |
timeIntervalFrom | string | Long-Term | The start of the relative time interval for the dashboard. | ||
viewName | string | yes | Long-Term | The name of the view of the scheduled report. |