Error
A valid request URL is required to generate request examples{
"results": {
"updatedByUserUuid": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"chart": {
"tableConfig": {
"columnOrder": [
"<string>"
]
},
"pivotConfig": {
"columns": [
"<string>"
]
},
"chartConfig": {
"type": "big_number",
"config": {
"comparisonField": "<string>",
"conditionalFormattings": [
{
"rules": [
{
"values": [
123
],
"operator": "isNull",
"id": "<string>",
"includeNull": true
}
],
"color": "<string>",
"target": {
"fieldId": "<string>"
},
"textStyle": {
"underline": true,
"italic": true,
"bold": true
},
"applyTo": "cell",
"darkColor": "<string>"
}
],
"comparisonLabel": "<string>",
"flipColors": true,
"comparisonFormat": "raw",
"showComparison": true,
"showTableNamesInLabel": true,
"showBigNumberLabel": true,
"selectedField": "<string>",
"style": "auto",
"label": "<string>"
}
},
"columns": [
{
"fieldType": "dimension",
"reference": "<string>"
}
],
"schemaVersion": 1
},
"pipeline": {
"nodes": [
{
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>",
"title": "<string>",
"nodeId": "<string>",
"sourceType": "semanticLayer",
"pivotConfiguration": {
"valuesColumns": [
{
"aggregation": "sum",
"reference": "<string>"
}
],
"foldOverflowGroups": true,
"pivotColumnsOrder": [
{
"reference": "<string>"
}
],
"passthroughDimensions": [
{
"reference": "<string>"
}
],
"sortOnlyDimensions": [
{
"reference": "<string>"
}
],
"sortOnlyColumns": [
{
"aggregation": "sum",
"reference": "<string>"
}
],
"metricsAsRows": true,
"sortBy": [
{
"direction": "ASC",
"reference": "<string>",
"pivotValues": [
{
"value": "<string>",
"reference": "<string>"
}
],
"nullsFirst": true
}
],
"groupByColumns": [
{
"reference": "<string>"
}
],
"indexColumn": {
"type": "time",
"reference": "<string>"
}
},
"parameters": {},
"timezone": "<string>",
"dimensionOverrides": {},
"metricOverrides": {},
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123
}
],
"additionalMetrics": [
{
"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
}
],
"tableCalculations": [
{
"displayName": "<string>",
"name": "<string>",
"sql": "<string>",
"totalMode": "formula",
"type": "number",
"format": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "auto",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>",
"pivotValues": [
{
"value": "<string>",
"reference": "<string>"
}
],
"nullsFirst": true
}
],
"filters": {
"tableCalculations": "<unknown>",
"metrics": "<unknown>",
"dimensions": "<unknown>"
},
"description": "<string>"
}
],
"terminalNodeId": "<string>",
"schemaVersion": 1
},
"versionUuid": "<string>",
"createdByUserUuid": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"slug": "<string>",
"description": "<string>",
"name": "<string>",
"dashboardUuid": "<string>",
"projectUuid": "<string>",
"uuid": "<string>"
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}v2
Get composer chart
Gets a composer chart’s current version, pipeline included. Anyone who can view the owning dashboard can read it.
GET
/
api
/
v2
/
projects
/
{projectUuid}
/
composer-charts
/
{composerChartUuid}
Error
A valid request URL is required to generate request examples{
"results": {
"updatedByUserUuid": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"chart": {
"tableConfig": {
"columnOrder": [
"<string>"
]
},
"pivotConfig": {
"columns": [
"<string>"
]
},
"chartConfig": {
"type": "big_number",
"config": {
"comparisonField": "<string>",
"conditionalFormattings": [
{
"rules": [
{
"values": [
123
],
"operator": "isNull",
"id": "<string>",
"includeNull": true
}
],
"color": "<string>",
"target": {
"fieldId": "<string>"
},
"textStyle": {
"underline": true,
"italic": true,
"bold": true
},
"applyTo": "cell",
"darkColor": "<string>"
}
],
"comparisonLabel": "<string>",
"flipColors": true,
"comparisonFormat": "raw",
"showComparison": true,
"showTableNamesInLabel": true,
"showBigNumberLabel": true,
"selectedField": "<string>",
"style": "auto",
"label": "<string>"
}
},
"columns": [
{
"fieldType": "dimension",
"reference": "<string>"
}
],
"schemaVersion": 1
},
"pipeline": {
"nodes": [
{
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>",
"title": "<string>",
"nodeId": "<string>",
"sourceType": "semanticLayer",
"pivotConfiguration": {
"valuesColumns": [
{
"aggregation": "sum",
"reference": "<string>"
}
],
"foldOverflowGroups": true,
"pivotColumnsOrder": [
{
"reference": "<string>"
}
],
"passthroughDimensions": [
{
"reference": "<string>"
}
],
"sortOnlyDimensions": [
{
"reference": "<string>"
}
],
"sortOnlyColumns": [
{
"aggregation": "sum",
"reference": "<string>"
}
],
"metricsAsRows": true,
"sortBy": [
{
"direction": "ASC",
"reference": "<string>",
"pivotValues": [
{
"value": "<string>",
"reference": "<string>"
}
],
"nullsFirst": true
}
],
"groupByColumns": [
{
"reference": "<string>"
}
],
"indexColumn": {
"type": "time",
"reference": "<string>"
}
},
"parameters": {},
"timezone": "<string>",
"dimensionOverrides": {},
"metricOverrides": {},
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123
}
],
"additionalMetrics": [
{
"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
}
],
"tableCalculations": [
{
"displayName": "<string>",
"name": "<string>",
"sql": "<string>",
"totalMode": "formula",
"type": "number",
"format": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "auto",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW",
"custom": "<string>"
},
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>",
"pivotValues": [
{
"value": "<string>",
"reference": "<string>"
}
],
"nullsFirst": true
}
],
"filters": {
"tableCalculations": "<unknown>",
"metrics": "<unknown>",
"dimensions": "<unknown>"
},
"description": "<string>"
}
],
"terminalNodeId": "<string>",
"schemaVersion": 1
},
"versionUuid": "<string>",
"createdByUserUuid": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"slug": "<string>",
"description": "<string>",
"name": "<string>",
"dashboardUuid": "<string>",
"projectUuid": "<string>",
"uuid": "<string>"
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Was this page helpful?