Get All Dashboard
Get all dashboards for a customer
Request
URI
GET
https://{api_host}/api/v2/dashboard
COPY
Query Parameters
integer
offset
Optional
offset
integer
limit
Optional
limit
Responses
200
successful operation
Returns ResponseContainerPagedDashboard of type(s) application/json
{
"status": {
"result": "string",
"message": "string",
"code": 0
},
"response": {
"items": [
{
"modifyAclAccess": false,
"hidden": false,
"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"
]
}
},
"anomalySampleSize": "string",
"anomalyType": "string",
"anomalySeverity": "string",
"interpolatePoints": false,
"anomalyDetectionOn": false,
"filterOutNonAnomalies": false,
"displayConfidenceBounds": false
}
]
}
]
}
],
"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"
]
},
"includeObsoleteMetrics": false,
"creatorId": "string",
"updaterId": "string",
"numCharts": 0,
"numFavorites": 0,
"favorite": false
}
],
"offset": 0,
"limit": 0,
"cursor": "string",
"totalItems": 0,
"moreItems": false,
"sort": {
"ascending": false,
"field": "string",
"default": false
}
}
}
Dashboard Operations
POST
Add Dashboard Access
PUT
Add Dashboard Tag
POST
Create Dashboard
DELETE
Delete Dashboard
POST
Favorite Dashboard
GET
Get All Dashboard
GET
Get Dashboard
GET
Get Dashboard Access Control List
GET
Get Dashboard History
GET
Get Dashboard Tags
GET
Get Dashboard Version
POST
Remove Dashboard Access
DELETE
Remove Dashboard Tag
PUT
Set Dashboard Acl
POST
Set Dashboard Tags
POST
Undelete Dashboard
POST
Unfavorite Dashboard
PUT
Update Dashboard