Create Dashboard
Create a specific dashboard
Request
URI
POST
https://{api_host}/api/v2/dashboard
COPY
Request Body
Example Body:
{
"name": "Dashboard API example",
"id": "api-example",
"url": "api-example",
"description": "Dashboard Description",
"sections": [
{
"name": "Section 1",
"rows": [
{
"charts": [
{
"name": "Chart 1",
"description": "description1",
"sources": [
{
"name": "Source1",
"query": "ts()"
}
]
}
]
}
]
}
]
}
Dashboard
of type(s)
application/json
Optional
Show optional properties
{
"name": "string",
"id": "string",
"url": "string",
"sections": [
{
"name": "string",
"rows": [
{
"charts": [
{
"name": "string",
"sources": [
{
"name": "string",
"query": "string"
}
]
}
]
}
]
}
]
}{
"modifyAclAccess": false,
"hidden": false,
"parameters": {
"parameters": "string"
},
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"systemOwned": false,
"tags": {
"customerTags": [
"string"
]
},
"orphan": false,
"deleted": false,
"customer": "string",
"url": "string",
"eventFilterType": "string",
"forceV2UI": false,
"sections": [
{
"name": "string",
"id": "string",
"rows": [
{
"heightFactor": 0,
"charts": [
{
"base": 0,
"units": "string",
"name": "string",
"description": "string",
"sources": [
{
"name": "string",
"query": "string",
"queryType": "string",
"querybuilderEnabled": false,
"querybuilderSerialization": "string",
"sourceDescription": "string",
"disabled": false,
"sourceColor": "string",
"secondaryAxis": false,
"scatterPlotSource": "string"
}
],
"noDefaultEvents": false,
"summarization": "string",
"includeObsoleteMetrics": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"chartAttributes": {},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": false,
"anomalyDetectionOn": false,
"filterOutNonAnomalies": false,
"displayConfidenceBounds": false
}
]
}
],
"sectionFilter": {}
}
],
"parameterDetails": {
"parameterDetails": {
"defaultValue": "string",
"description": "string",
"label": "string",
"parameterType": "string",
"valuesToReadableStrings": {
"valuesToReadableStrings": "string"
},
"multivalue": false,
"allowAll": false,
"dynamicFieldType": "string",
"queryValue": "string",
"hideFromView": false,
"tagKey": "string",
"reverseDynSort": false,
"valueOrdering": [
"string"
],
"order": 0,
"tagsBlackListRegex": "string"
}
},
"disableRefreshInLiveMode": false,
"hideChartWarning": false,
"displayDescription": false,
"displaySectionTableOfContents": false,
"displayQueryParameters": false,
"chartTitleScalar": 0,
"eventQuery": "string",
"defaultTimeWindow": "string",
"defaultStartTime": 0,
"defaultEndTime": 0,
"chartTitleColor": "string",
"chartTitleBgColor": "string",
"viewsLastDay": 0,
"viewsLastWeek": 0,
"viewsLastMonth": 0,
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"dashboardAttributes": {},
"includeObsoleteMetrics": false,
"creatorId": "string",
"updaterId": "string",
"numCharts": 0,
"numFavorites": 0,
"favorite": false
}Responses
200
successful operation
Returns
ResponseContainerDashboard
of type(s)
application/json
"ResponseContainerDashboard Object"
object
status
Required
status
object
response
Optional
Wavefront dashboard entity
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"id:"string","name:"string","sections":["object"],"url:"string"}' https://{api_host}/api/v2/dashboard
Dashboard Operations
GET
Get All Dashboard
POST
Create Dashboard
GET
Get Dashboard Access Control List
POST
Add Dashboard Access
POST
Remove Dashboard Access
PUT
Set Dashboard Acl
GET
Get Dashboard
PUT
Update Dashboard
DELETE
Delete Dashboard
POST
Favorite Dashboard
GET
Get Dashboard History
GET
Get Dashboard Version
GET
Get Dashboard Tags
POST
Set Dashboard Tags
PUT
Add Dashboard Tag
DELETE
Remove Dashboard Tag
POST
Undelete Dashboard
POST
Unfavorite Dashboard