Update dashboard report schedule.

Update the schedule of a scheduled dashboard report by the given identifier.

scheduleIdstring required

identifier of the dashboard report schedule to update.

Request body

dashboardIdstring required

Identifier of dashboard the schedule will generate report for.

reportFormatstring required

File format of the report. Can be Pdf or Png. Pdf is portable document format. Png is portable graphics image format.

scheduleTypestring required

Run schedule of the scheduled report. Set to "Custom" to specify the schedule with a CRON expression. Possible schedule types are:

RealTime
15Minutes
1Hour
2Hours
4Hours
6Hours
8Hours
12Hours
1Day
1Week
Custom

cronExpressionstring

Cron-like expression specifying the report's schedule. Field scheduleType must be set to "Custom", otherwise, scheduleType takes precedence over cronExpression.

timeZonestring required

Time zone identifier for time specification. Either an abbreviation such as "PST", a full name such as "America/Los_Angeles", or a custom ID such as "GMT-8:00". Note that the support of abbreviations is for JDK 1.1.x compatibility only and full names should be used.

isActiveboolean

Is the dashboard report schedule active

themestring

Theme for the report rendering. Must be Light or Dark. If absent, the dashboard's own theme is used.

exportWidthinteger

Pixel width of the exported PDF or PNG. If absent, the default width is used.

Example request

{
  "dashboardId": "B23OjNs5ZCyn5VdMwOBoLo3PjgRnJSAlNTKEDAcpuDG2CIgRe9KFXMofm2H2",
  "timeRange": {
    "type": "BeginBoundedTimeRange",
    "from": {
      "type": "RelativeTimeRangeBoundary",
      "relativeTime": "-15m"
    }
  },
  "reportFormat": "Pdf",
  "scheduleType": "1Day",
  "cronExpression": "0 0/15 * * * ? *",
  "timeZone": "America/Los_Angeles",
  "emailNotification": {
    "recipients": [
      "john@doe.com"
    ],
    "subject": "Sample Email Subject",
    "messageBody": "Sample Email Message Body",
    "timeZone": "America/Los_Angeles"
  },
  "theme": "Light",
  "exportWidth": 1500
}

Response

The dashboard report schedule was successfully modified.