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'.

Servers

https://api.au.sumologic.com/api/
https://api.ca.sumologic.com/api/
https://api.de.sumologic.com/api/
https://api.eu.sumologic.com/api/
https://api.fed.sumologic.com/api/
https://api.jp.sumologic.com/api/
https://api.kr.sumologic.com/api/
https://api.in.sumologic.com/api/
https://api.sumologic.com/api/
https://api.us2.sumologic.com/api/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`reportFormat`	String	Yes	File format of the report. Can be `Pdf` or `Png`. `Pdf` is portable document format. `Png` is portable graphics image format.
`scheduleType`	String	Yes	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`
`isActive`	Boolean	No	Is the dashboard report schedule active Default value: true
`timeRange`	Object	No
`timeRange.type`	String	Yes	Type of the time range. Value must be either `CompleteLiteralTimeRange` or `BeginBoundedTimeRange`.
`variableValues`	Object	No
`variableValues.data`	Object	Yes	Data for variable values.
`variableValues.data.name`	String	No
`variableValues.richData`	Object	No	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.
`variableValues.richData.name`	Object	No	Variable values, status, type and errors for the variable values search.
`variableValues.richData.name.variableKey`	String	No	The key of the variable.
`variableValues.richData.name.errors[]`	Array	No	Generic errors returned by backend from downstream assemblies. More specific errors will be thrown in the future.
`variableValues.richData.name.errors[].message`	String	Yes	A short English-language description of the error.
`variableValues.richData.name.errors[].meta`	Object	No	An optional list of metadata about the error.
`variableValues.richData.name.errors[].code`	String	Yes	An error code describing the type of error.
`variableValues.richData.name.errors[].detail`	String	No	An optional fuller English-language description of the error.
`variableValues.richData.name.status`	Object	No
`variableValues.richData.name.status.state`	String	Yes	Current state of the search.
`variableValues.richData.name.status.percentCompleted`	Integer	No	Percentage of search completed.
`variableValues.richData.name.variableType`	String	No	The type of the variable.
`variableValues.richData.name.valueType`	String	No	The type of value of the variable. Allowed values are `String`, Any`,`Numeric`,`Integer`,`Long`,`Double`,`Boolean`. -`String`considers as a single phrase and will wrap in double-quotes. -`Any`is all characters. -`Numeric`consists of a numeric value for variables, it will be displayed differently in the UI. -`Integer`is a variable with an`Int`value. -`Long`is a variable with a`Long`value. -`Double`is a variable with a`Double`value. -`Boolean`is a variable with a`Boolean` value. Default value: "Any"
`variableValues.richData.name.variableValues[]`	Array	Yes	Values for the variable.
`variableValues.richData.name.allowMultiSelect`	Boolean	No	Allow multiple selections in the values dropdown. Default value: false
`cronExpression`	String	No	Cron-like expression specifying the report's schedule. Field scheduleType must be set to "Custom", otherwise, scheduleType takes precedence over cronExpression.
`dashboardId`	String	Yes	Identifier of dashboard the schedule will generate report for.
`timeZone`	String	Yes	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.