Error
A valid request URL is required to generate request examples{
"results": {
"owner": {
"email": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
},
"colorPaletteUuid": "<string>",
"slug": "<string>",
"access": [
{
"hasDirectAccess": true,
"role": "viewer",
"userUuid": "<string>",
"grantedVia": "app",
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer"
}
],
"inheritsFromOrgOrProject": true,
"tabs": [
{
"order": 1,
"name": "<string>",
"uuid": "<string>",
"hidden": true
}
],
"pinnedListOrder": 123,
"pinnedListUuid": "<string>",
"firstViewedAt": "2023-11-07T05:31:56Z",
"views": 123,
"spaceName": "<string>",
"spaceUuid": "<string>",
"filters": {
"tableCalculations": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true,
"lockedTabUuids": [
"<string>"
],
"requiredGroupId": "<string>",
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
],
"metrics": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true,
"lockedTabUuids": [
"<string>"
],
"requiredGroupId": "<string>",
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
],
"dimensions": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true,
"lockedTabUuids": [
"<string>"
],
"requiredGroupId": "<string>",
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
]
},
"tiles": [
{
"uuid": "<string>",
"type": "saved_chart",
"x": 123,
"y": 123,
"h": 123,
"w": 123,
"properties": {
"savedChartUuid": "<string>",
"chartSlug": "<string>",
"lastVersionChartKind": "line",
"chartName": "<string>",
"belongsToDashboard": true,
"hideTitle": true,
"title": "<string>"
},
"tabUuid": "<string>"
}
],
"updatedAt": "2023-11-07T05:31:56Z",
"verification": {
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
},
"name": "<string>",
"uuid": "<string>",
"versionUuid": "<string>",
"dashboardVersionId": 123,
"projectUuid": "<string>",
"organizationUuid": "<string>",
"deletedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
},
"deletedAt": "2023-11-07T05:31:56Z",
"config": {
"isDateZoomDisabled": true,
"customMetrics": [
{
"type": "percentile",
"sql": "<string>",
"table": "<string>",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"hidden": true,
"round": 123,
"compact": "auto",
"format": "km",
"separator": "default",
"index": 123,
"filters": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"baseDimensionName": "<string>",
"baseMetricName": "<string>",
"uuid": "<string>",
"percentile": 123,
"distinctKeys": [
"<string>"
],
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "auto",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"generationType": "periodOverPeriod",
"baseMetricId": "<string>",
"timeDimensionId": "<string>",
"granularity": "RAW",
"periodOffset": 123
}
],
"requiredFiltersNote": "<string>",
"dateZoomConfig": {
"tileTargets": {},
"controls": [
{
"granularity": "Second",
"name": "<string>",
"uuid": "<string>",
"hidden": true
}
]
},
"defaultDateZoomGranularity": "Second",
"dateZoomGranularities": [
"Second"
],
"parameterOrder": [
"<string>"
],
"pinnedParameters": [
"<string>"
],
"isAddFilterDisabled": true
},
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"parameters": {},
"description": "<string>",
"draftStaleness": {
"conflictingFields": [
"<string>"
],
"changedFields": [
"<string>"
],
"draftUuid": "<string>"
},
"dismissedDraftUuid": "<string>",
"draftOverlayError": {
"draftUuid": "<string>",
"code": "invalid_dashboard_draft"
},
"draftsAwaitingReview": 123,
"hasUnpublishedChanges": true
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}v2
Update dashboard
Update a dashboard by uuid or slug within a project
PATCH
/
api
/
v2
/
projects
/
{projectUuid}
/
dashboards
/
{dashboardUuidOrSlug}
Error
A valid request URL is required to generate request examples{
"results": {
"owner": {
"email": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
},
"colorPaletteUuid": "<string>",
"slug": "<string>",
"access": [
{
"hasDirectAccess": true,
"role": "viewer",
"userUuid": "<string>",
"grantedVia": "app",
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer"
}
],
"inheritsFromOrgOrProject": true,
"tabs": [
{
"order": 1,
"name": "<string>",
"uuid": "<string>",
"hidden": true
}
],
"pinnedListOrder": 123,
"pinnedListUuid": "<string>",
"firstViewedAt": "2023-11-07T05:31:56Z",
"views": 123,
"spaceName": "<string>",
"spaceUuid": "<string>",
"filters": {
"tableCalculations": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true,
"lockedTabUuids": [
"<string>"
],
"requiredGroupId": "<string>",
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
],
"metrics": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true,
"lockedTabUuids": [
"<string>"
],
"requiredGroupId": "<string>",
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
],
"dimensions": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true,
"lockedTabUuids": [
"<string>"
],
"requiredGroupId": "<string>",
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
]
},
"tiles": [
{
"uuid": "<string>",
"type": "saved_chart",
"x": 123,
"y": 123,
"h": 123,
"w": 123,
"properties": {
"savedChartUuid": "<string>",
"chartSlug": "<string>",
"lastVersionChartKind": "line",
"chartName": "<string>",
"belongsToDashboard": true,
"hideTitle": true,
"title": "<string>"
},
"tabUuid": "<string>"
}
],
"updatedAt": "2023-11-07T05:31:56Z",
"verification": {
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
},
"name": "<string>",
"uuid": "<string>",
"versionUuid": "<string>",
"dashboardVersionId": 123,
"projectUuid": "<string>",
"organizationUuid": "<string>",
"deletedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
},
"deletedAt": "2023-11-07T05:31:56Z",
"config": {
"isDateZoomDisabled": true,
"customMetrics": [
{
"type": "percentile",
"sql": "<string>",
"table": "<string>",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"hidden": true,
"round": 123,
"compact": "auto",
"format": "km",
"separator": "default",
"index": 123,
"filters": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"baseDimensionName": "<string>",
"baseMetricName": "<string>",
"uuid": "<string>",
"percentile": 123,
"distinctKeys": [
"<string>"
],
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "auto",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"generationType": "periodOverPeriod",
"baseMetricId": "<string>",
"timeDimensionId": "<string>",
"granularity": "RAW",
"periodOffset": 123
}
],
"requiredFiltersNote": "<string>",
"dateZoomConfig": {
"tileTargets": {},
"controls": [
{
"granularity": "Second",
"name": "<string>",
"uuid": "<string>",
"hidden": true
}
]
},
"defaultDateZoomGranularity": "Second",
"dateZoomGranularities": [
"Second"
],
"parameterOrder": [
"<string>"
],
"pinnedParameters": [
"<string>"
],
"isAddFilterDisabled": true
},
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"parameters": {},
"description": "<string>",
"draftStaleness": {
"conflictingFields": [
"<string>"
],
"changedFields": [
"<string>"
],
"draftUuid": "<string>"
},
"dismissedDraftUuid": "<string>",
"draftOverlayError": {
"draftUuid": "<string>",
"code": "invalid_dashboard_draft"
},
"draftsAwaitingReview": 123,
"hasUnpublishedChanges": true
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Body
application/json
Was this page helpful?