--- title: "Schedule dashboard report" method: POST path: "/v1/dashboards/reportSchedules" tags: ["dashboardManagement"] --- # Schedule dashboard report `POST /v1/dashboards/reportSchedules` Schedule dashboard report to send at a specific date and time. The report should be sent as attachment or downloadable URL in one of the following notification types: 'Email', 'AWSLambda', 'AzureFunctions', 'Datadog', 'HipChat', 'Jira', 'NewRelic', 'Opsgenie', 'PagerDuty', 'Slack', 'MicrosoftTeams', 'ServiceNow', 'SumoCloudSOAR' and 'Webhook'. ## Request body - ReportScheduleRequest - `dashboardId` string, required — Identifier of dashboard the schedule will generate report for. - `timeRange` ResolvableTimeRange - `type` string, required — Type of the time range. Value must be either `CompleteLiteralTimeRange` or `BeginBoundedTimeRange`. - `variableValues` VariablesValuesData - `data` object, required — Data for variable values. - `richData` object — A rich form of data for the variable search, including variable values, status and variable type. This field is different from `data` in that it includes an object instead of list as the value in the map. The `data` field is kept for backwards compatibility, please use `richData` for all usages going forward. - `reportFormat` string, required — File format of the report. Can be `Pdf` or `Png`. `Pdf` is portable document format. `Png` is portable graphics image format. - `scheduleType` string, 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` - `cronExpression` string — Cron-like expression specifying the report's schedule. Field scheduleType must be set to "Custom", otherwise, scheduleType takes precedence over cronExpression. - `timeZone` string, 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. - `emailNotification` Email, required — The base class of all connection types. - `connectionType` string, required — Connection type of the connection. Valid values: 1. `Email` 2. `AWSLambda` 3. `AzureFunctions` 4. `Datadog` 5. `HipChat` 6. `Jira` 7. `NewRelic` 8. `Opsgenie` 9. `PagerDuty` 10. `Slack` 11. `MicrosoftTeams` 12. `ServiceNow` 13. `SumoCloudSOAR` 14. `Webhook` - `recipients` string[], required — A list of email addresses to send to when the rule fires. - `subject` string, required — The subject line of the email. - `messageBody` string — The message body of the email to send. - `timeZone` string — Time zone for the email content. All dates/times will be displayed in this timeZone in the email payload. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). - `includeQuery` boolean — Whether to include the triggering query in the notification email. - `includeResultSet` boolean — Whether to include the result set in the notification email. This field is not applicable for SLO monitors. - `isActive` boolean — Is the dashboard report schedule active - `theme` string — Theme for the report rendering. Must be `Light` or `Dark`. If absent, the dashboard's own theme is used. - `exportWidth` integer — Pixel width of the exported PDF or PNG. If absent, the default width is used. ## Response `200` Dashboard report has been scheduled. - ReportSchedule - `dashboardId` string, required — Identifier of dashboard the schedule will generate report for. - `timeRange` ResolvableTimeRange - `type` string, required — Type of the time range. Value must be either `CompleteLiteralTimeRange` or `BeginBoundedTimeRange`. - `variableValues` VariablesValuesData - `data` object, required — Data for variable values. - `richData` object — A rich form of data for the variable search, including variable values, status and variable type. This field is different from `data` in that it includes an object instead of list as the value in the map. The `data` field is kept for backwards compatibility, please use `richData` for all usages going forward. - `reportFormat` string, required — File format of the report. Can be `Pdf` or `Png`. `Pdf` is portable document format. `Png` is portable graphics image format. - `scheduleType` string, 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` - `cronExpression` string — Cron-like expression specifying the report's schedule. Field scheduleType must be set to "Custom", otherwise, scheduleType takes precedence over cronExpression. - `timeZone` string, 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. - `emailNotification` Email, required — The base class of all connection types. - `connectionType` string, required — Connection type of the connection. Valid values: 1. `Email` 2. `AWSLambda` 3. `AzureFunctions` 4. `Datadog` 5. `HipChat` 6. `Jira` 7. `NewRelic` 8. `Opsgenie` 9. `PagerDuty` 10. `Slack` 11. `MicrosoftTeams` 12. `ServiceNow` 13. `SumoCloudSOAR` 14. `Webhook` - `recipients` string[], required — A list of email addresses to send to when the rule fires. - `subject` string, required — The subject line of the email. - `messageBody` string — The message body of the email to send. - `timeZone` string — Time zone for the email content. All dates/times will be displayed in this timeZone in the email payload. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). - `includeQuery` boolean — Whether to include the triggering query in the notification email. - `includeResultSet` boolean — Whether to include the result set in the notification email. This field is not applicable for SLO monitors. - `isActive` boolean — Is the dashboard report schedule active - `theme` string — Theme for the report rendering. Must be `Light` or `Dark`. If absent, the dashboard's own theme is used. - `exportWidth` integer — Pixel width of the exported PDF or PNG. If absent, the default width is used. - `scheduleId` string — Identifier of the dashboard report schedule. ## Other responses - `default` — Operation failed with an error. --- [API](https://skmtc.net/sumologic/apis/sumo-logic-api.md) · [All operations](https://skmtc.net/sumologic/apis/sumo-logic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumologic/sumo-logic-api/versions/18a824df1e78/schema)