UpdateScheduledReportInput
is used to input data for updating a scheduled report.
Table: UpdateScheduledReportInput
| 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: Feb 26, 2025 | |||||
dashboardId | string | The unique identifier of the dashboard for which the report was created. | |||
description | string | Description of the scheduled report. | |||
enabled | boolean | yes | Flag indicating whether the scheduled report is enabled. | ||
id | string | yes | The unique identifier of the scheduled report. | ||
labels | [string] | yes | Labels attached to the scheduled report. | ||
layout | UpdateScheduledReportLayoutInput | Layout of the scheduled report. See UpdateScheduledReportLayoutInput. | |||
Name | string | The name of the scheduled report. | |||
parameters | [UpdateScheduledReportParameterValueInput] | yes | A list of parameter value configurations. See UpdateScheduledReportParameterValueInput. | ||
password | string | The password used to protect any generated reports. | |||
recipients | [string] | A list of recipients who should receive an email with the generated report. | |||
schedule | UpdateScheduledReportScheduleInput | The schedule by which to run the report. See UpdateScheduledReportScheduleInput. | |||
timeIntervalFrom | string | The start of the relative time interval for the dashboard. | |||
viewName | string | yes | The name of the view of the scheduled report. | ||