Error
A valid request URL is required to generate request examples{
"results": {
"offset": 123,
"total": 123,
"spaces": [
{
"slug": "<string>",
"spaceName": "<string>",
"contentType": "space",
"access": {
"groups": [
{
"role": "viewer",
"name": "<string>"
}
],
"users": [
{
"role": "viewer",
"email": "<string>"
}
],
"projectMemberAccessRole": "viewer",
"inheritParentPermissions": true
},
"version": 1
}
],
"missingIds": [
"<string>"
],
"dashboards": [
{
"spaceSlug": "<string>",
"version": 123,
"tiles": [
{
"w": 18.5,
"h": 2,
"y": 1,
"x": 17.5,
"type": "saved_chart",
"properties": {
"chartSlug": "<string>",
"title": "<string>",
"hideTitle": true,
"chartName": "<string>"
},
"tabUuid": "<string>",
"tabSlug": "<string>",
"tileSlug": "<string>",
"uuid": "<string>"
}
],
"tabs": [
{
"order": 1,
"name": "<string>",
"hidden": true,
"uuid": "<string>",
"slug": "<string>"
}
],
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"parameters": {},
"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
},
"verification": {
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
},
"verified": true,
"ownerEmail": "<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": [
{
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"operator": "isNull",
"label": "<string>",
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true,
"values": [
"<unknown>"
],
"includeNull": true,
"tileTargets": {},
"singleValue": true,
"requiredGroupId": "<string>",
"lockedTabUuids": [
"<string>"
]
}
]
},
"downloadedAt": "2023-11-07T05:31:56Z",
"contentType": "dashboard",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"languageMap": [
{
"dashboard": {}
}
]
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Projects
List dashboards as code
Get dashboards in code representation
GET
/
api
/
v1
/
projects
/
{projectUuid}
/
code
/
dashboards
Error
A valid request URL is required to generate request examples{
"results": {
"offset": 123,
"total": 123,
"spaces": [
{
"slug": "<string>",
"spaceName": "<string>",
"contentType": "space",
"access": {
"groups": [
{
"role": "viewer",
"name": "<string>"
}
],
"users": [
{
"role": "viewer",
"email": "<string>"
}
],
"projectMemberAccessRole": "viewer",
"inheritParentPermissions": true
},
"version": 1
}
],
"missingIds": [
"<string>"
],
"dashboards": [
{
"spaceSlug": "<string>",
"version": 123,
"tiles": [
{
"w": 18.5,
"h": 2,
"y": 1,
"x": 17.5,
"type": "saved_chart",
"properties": {
"chartSlug": "<string>",
"title": "<string>",
"hideTitle": true,
"chartName": "<string>"
},
"tabUuid": "<string>",
"tabSlug": "<string>",
"tileSlug": "<string>",
"uuid": "<string>"
}
],
"tabs": [
{
"order": 1,
"name": "<string>",
"hidden": true,
"uuid": "<string>",
"slug": "<string>"
}
],
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"parameters": {},
"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
},
"verification": {
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
},
"verified": true,
"ownerEmail": "<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": [
{
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"operator": "isNull",
"label": "<string>",
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true,
"values": [
"<unknown>"
],
"includeNull": true,
"tileTargets": {},
"singleValue": true,
"requiredGroupId": "<string>",
"lockedTabUuids": [
"<string>"
]
}
]
},
"downloadedAt": "2023-11-07T05:31:56Z",
"contentType": "dashboard",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"languageMap": [
{
"dashboard": {}
}
]
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Was this page helpful?