POST /v2/dashboards

Creates a new dashboard.

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
`isPublic`	Boolean	No	Is the dashboard public Default value: false
`description`	String	No	Description of the dashboard.
`layout`	Object	No
`layout.layoutStructures[]`	Array	Yes	Layout structures for the panel childen.
`layout.layoutStructures[].key`	String	Yes	The identifier of the panel that this structure applies to.
`layout.layoutStructures[].structure`	String	Yes	The structure of a panel.
`layout.layoutType`	String	Yes	The type of panel layout on the Dashboard. For example, Grid, Tabs, or Hierarchical. Currently supports `Grid` only.
`topologyLabelMap`	Object	No	Map of the topology labels. Each label has a key and a list of values. If a value is `*`, it means the label will match content for all values of its key.
`topologyLabelMap.data`	Object	Yes	Map from topology labels to `TopologyLabelValuesList`.
`topologyLabelMap.data.name`	String	No	Value of the label.
`domain`	String	No	If set denotes that the dashboard concerns a given domain (e.g. `aws`, `k8s`, `app`).
`timeRange`	Object	Yes
`timeRange.type`	String	Yes	Type of the time range. Value must be either `CompleteLiteralTimeRange` or `BeginBoundedTimeRange`.
`panels[]`	Array	No	Panels in the dashboard.
`panels[].id`	String	No	Unique identifier for the panel.
`panels[].panelType`	String	Yes	Type of panel.
`panels[].keepVisualSettingsConsistentWithParent`	Boolean	No	Keeps the visual settings, like series colors, consistent with the settings of the parent panel. Default value: true
`panels[].visualSettings`	String	No	Visual settings of the panel.
`panels[].key`	String	Yes	Key for the panel. Used to create searches for the queries in the panel and configure the layout of the panel in the dashboard.
`panels[].title`	String	No	Title of the panel.
`theme`	String	No	Theme for the dashboard. Either `Light` or `Dark`. Default value: "Light"
`refreshInterval`	Integer	No	Interval of time (in seconds) to automatically refresh the dashboard. A value of 0 means we never automatically refresh the dashboard. Allowed values are `0`, `30`, `60`, `120`, `300`, `900`, `1800`, `3600`, `7200`, `86400`.
`highlightViolations`	Boolean	No	Whether to highlight threshold violations. Default value: false
`title`	String	Yes	Title of the dashboard.
`folderId`	String	No	The identifier of the folder to save the dashboard in. By default it is saved in your personal folder.
`variables[]`	Array	No	Variables to apply to the panels.
`variables[].id`	String	No	Unique identifier for the variable.
`variables[].name`	String	Yes	Name of the variable. The variable name is case-insensitive.
`variables[].defaultValue`	String	No	Default value of the variable.
`variables[].includeAllOption`	Boolean	No	Include an "All" option at the top of the variable's values dropdown. Default value: true
`variables[].hideFromUI`	Boolean	No	Hide the variable in the dashboard UI. Default value: false
`variables[].displayName`	String	No	Display name of the variable shown in the UI. If this field is empty, the name field will be used. The display name is case-insensitive. Only numbers, and underscores are allowed in the variable name. This field is not yet supported by the UI.
`variables[].sourceDefinition`	Object	Yes
`variables[].sourceDefinition.variableSourceType`	String	Yes	Source type of the variable values.
`variables[].valueType`	String	No	The type of value of the variable. Allowed values are `String`, Any`and`Numeric`. -`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"
`variables[].allowMultiSelect`	Boolean	No	Allow multiple selections in the values dropdown. Default value: false
`hierarchies[]`	Array	No	If set to non-empty array denotes that the dashboard concerns given hierarchies.

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.