Error
A valid request URL is required to generate request examples{
"results": {
"charts": [
{
"data": {
"name": "<string>",
"tableName": "<string>",
"metricQuery": {
"tableCalculations": [
{
"displayName": "<string>",
"name": "<string>",
"sql": "<string>",
"format": {
"round": 123,
"currency": "<string>",
"prefix": "<string>",
"suffix": "<string>",
"custom": "<string>"
},
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>",
"pivotValues": [
{
"value": "<string>",
"reference": "<string>"
}
],
"nullsFirst": true
}
],
"filters": {
"tableCalculations": {
"or": [
{
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
},
"metrics": {
"or": [
{
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
},
"dimensions": {
"or": [
{
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
}
},
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>",
"metadata": {
"hasADateDimension": {
"name": "<string>",
"label": "<string>",
"table": "<string>"
}
},
"pivotDimensions": [
"<string>"
],
"timezone": "<string>",
"dimensionOverrides": {},
"metricOverrides": {},
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123
}
],
"additionalMetrics": [
{
"sql": "<string>",
"table": "<string>",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"hidden": true,
"round": 123,
"index": 123,
"filters": [
{
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"baseDimensionName": "<string>",
"uuid": "<string>",
"percentile": 123,
"distinctKeys": [
"<string>"
],
"formatOptions": {
"round": 123,
"currency": "<string>",
"prefix": "<string>",
"suffix": "<string>",
"custom": "<string>"
},
"generationType": "periodOverPeriod",
"baseMetricId": "<string>",
"timeDimensionId": "<string>",
"periodOffset": 123
}
]
},
"chartConfig": {
"type": "big_number",
"config": {
"comparisonField": "<string>",
"conditionalFormattings": [
{
"rules": [
{
"values": [
123
],
"id": "<string>",
"includeNull": true
}
],
"color": "<string>",
"target": {
"fieldId": "<string>"
},
"textStyle": {
"underline": true,
"italic": true,
"bold": true
},
"darkColor": "<string>"
}
],
"comparisonLabel": "<string>",
"flipColors": true,
"showComparison": true,
"showTableNamesInLabel": true,
"showBigNumberLabel": true,
"selectedField": "<string>",
"label": "<string>"
}
},
"slug": "<string>",
"uuid": "<string>",
"organizationUuid": "<string>",
"projectUuid": "<string>",
"pinnedListUuid": "<string>",
"pinnedListOrder": 123,
"verification": {
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"spaceUuid": "<string>",
"spaceName": "<string>",
"colorPaletteUuid": "<string>",
"tableConfig": {
"columnOrder": [
"<string>"
]
},
"dashboardUuid": "<string>",
"dashboardName": "<string>",
"colorPalette": [
"<string>"
],
"resolvedColorPalette": {
"source": {
"type": "config"
},
"paletteName": "<string>",
"paletteUuid": "<string>",
"darkColors": [
"<string>"
],
"colors": [
"<string>"
]
},
"oldUuid": "<string>",
"spacePath": "<string>",
"spaceSlug": "<string>",
"description": "<string>",
"pivotConfig": {
"columns": [
"<string>"
]
},
"parameters": {},
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
}
}
],
"dashboards": [
{
"data": {
"name": "<string>",
"slug": "<string>",
"filters": {
"tableCalculations": [
{
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<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": [
{
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<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": [
{
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"isSqlColumn": true
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true,
"lockedTabUuids": [
"<string>"
],
"requiredGroupId": "<string>",
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
]
},
"tabs": [
{
"order": 1,
"name": "<string>",
"uuid": "<string>",
"hidden": true
}
],
"uuid": "<string>",
"organizationUuid": "<string>",
"projectUuid": "<string>",
"pinnedListUuid": "<string>",
"pinnedListOrder": 123,
"dashboardVersionId": 123,
"versionUuid": "<string>",
"verification": {
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"tiles": [
{
"uuid": "<string>",
"type": "saved_chart",
"x": 123,
"y": 123,
"h": 123,
"w": 123,
"properties": {
"savedChartUuid": "<string>",
"chartSlug": "<string>",
"chartName": "<string>",
"belongsToDashboard": true,
"hideTitle": true,
"title": "<string>"
},
"tabUuid": "<string>"
}
],
"spaceUuid": "<string>",
"spaceName": "<string>",
"views": 123,
"firstViewedAt": "<string>",
"colorPaletteUuid": "<string>",
"spacePath": "<string>",
"spaceSlug": "<string>",
"description": "<string>",
"parameters": {},
"config": {
"isDateZoomDisabled": true,
"requiredFiltersNote": "<string>",
"dateZoomConfig": {
"tileTargets": {},
"controls": [
{
"name": "<string>",
"uuid": "<string>",
"hidden": true
}
]
},
"dateZoomGranularities": [],
"parameterOrder": [
"<string>"
],
"pinnedParameters": [
"<string>"
],
"isAddFilterDisabled": true
},
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
}
}
],
"spaces": [
{
"data": {
"name": "<string>",
"slug": "<string>",
"uuid": "<string>",
"organizationUuid": "<string>",
"projectUuid": "<string>",
"inheritParentPermissions": true,
"pinnedListUuid": "<string>",
"pinnedListOrder": 123,
"parentSpaceUuid": "<string>",
"path": "<string>",
"appCount": 123,
"childSpaceCount": 123,
"dashboardCount": 123,
"chartCount": 123,
"deletedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
},
"deletedAt": "2023-11-07T05:31:56Z"
}
}
],
"dataApps": [
{
"data": {
"name": "<string>",
"uuid": "<string>"
}
}
],
"sqlCharts": [
{
"data": {
"spacePath": "<string>",
"spaceSlug": "<string>",
"description": "<string>",
"name": "<string>",
"projectUuid": "<string>",
"slug": "<string>",
"oldUuid": "<string>",
"uuid": "<string>"
}
}
]
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Projects
Upsert SQL chart as code (deprecated)
deprecated
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
sqlCharts
/
{slug}
/
code
Error
A valid request URL is required to generate request examples{
"results": {
"charts": [
{
"data": {
"name": "<string>",
"tableName": "<string>",
"metricQuery": {
"tableCalculations": [
{
"displayName": "<string>",
"name": "<string>",
"sql": "<string>",
"format": {
"round": 123,
"currency": "<string>",
"prefix": "<string>",
"suffix": "<string>",
"custom": "<string>"
},
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>",
"pivotValues": [
{
"value": "<string>",
"reference": "<string>"
}
],
"nullsFirst": true
}
],
"filters": {
"tableCalculations": {
"or": [
{
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
},
"metrics": {
"or": [
{
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
},
"dimensions": {
"or": [
{
"id": "<string>",
"target": {
"fieldId": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"id": "<string>"
}
},
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>",
"metadata": {
"hasADateDimension": {
"name": "<string>",
"label": "<string>",
"table": "<string>"
}
},
"pivotDimensions": [
"<string>"
],
"timezone": "<string>",
"dimensionOverrides": {},
"metricOverrides": {},
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123
}
],
"additionalMetrics": [
{
"sql": "<string>",
"table": "<string>",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"hidden": true,
"round": 123,
"index": 123,
"filters": [
{
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true
}
],
"baseDimensionName": "<string>",
"uuid": "<string>",
"percentile": 123,
"distinctKeys": [
"<string>"
],
"formatOptions": {
"round": 123,
"currency": "<string>",
"prefix": "<string>",
"suffix": "<string>",
"custom": "<string>"
},
"generationType": "periodOverPeriod",
"baseMetricId": "<string>",
"timeDimensionId": "<string>",
"periodOffset": 123
}
]
},
"chartConfig": {
"type": "big_number",
"config": {
"comparisonField": "<string>",
"conditionalFormattings": [
{
"rules": [
{
"values": [
123
],
"id": "<string>",
"includeNull": true
}
],
"color": "<string>",
"target": {
"fieldId": "<string>"
},
"textStyle": {
"underline": true,
"italic": true,
"bold": true
},
"darkColor": "<string>"
}
],
"comparisonLabel": "<string>",
"flipColors": true,
"showComparison": true,
"showTableNamesInLabel": true,
"showBigNumberLabel": true,
"selectedField": "<string>",
"label": "<string>"
}
},
"slug": "<string>",
"uuid": "<string>",
"organizationUuid": "<string>",
"projectUuid": "<string>",
"pinnedListUuid": "<string>",
"pinnedListOrder": 123,
"verification": {
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"spaceUuid": "<string>",
"spaceName": "<string>",
"colorPaletteUuid": "<string>",
"tableConfig": {
"columnOrder": [
"<string>"
]
},
"dashboardUuid": "<string>",
"dashboardName": "<string>",
"colorPalette": [
"<string>"
],
"resolvedColorPalette": {
"source": {
"type": "config"
},
"paletteName": "<string>",
"paletteUuid": "<string>",
"darkColors": [
"<string>"
],
"colors": [
"<string>"
]
},
"oldUuid": "<string>",
"spacePath": "<string>",
"spaceSlug": "<string>",
"description": "<string>",
"pivotConfig": {
"columns": [
"<string>"
]
},
"parameters": {},
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
}
}
],
"dashboards": [
{
"data": {
"name": "<string>",
"slug": "<string>",
"filters": {
"tableCalculations": [
{
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<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": [
{
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<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": [
{
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"isSqlColumn": true
},
"includeNull": true,
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"caseSensitive": true,
"lockedTabUuids": [
"<string>"
],
"requiredGroupId": "<string>",
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
]
},
"tabs": [
{
"order": 1,
"name": "<string>",
"uuid": "<string>",
"hidden": true
}
],
"uuid": "<string>",
"organizationUuid": "<string>",
"projectUuid": "<string>",
"pinnedListUuid": "<string>",
"pinnedListOrder": 123,
"dashboardVersionId": 123,
"versionUuid": "<string>",
"verification": {
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"tiles": [
{
"uuid": "<string>",
"type": "saved_chart",
"x": 123,
"y": 123,
"h": 123,
"w": 123,
"properties": {
"savedChartUuid": "<string>",
"chartSlug": "<string>",
"chartName": "<string>",
"belongsToDashboard": true,
"hideTitle": true,
"title": "<string>"
},
"tabUuid": "<string>"
}
],
"spaceUuid": "<string>",
"spaceName": "<string>",
"views": 123,
"firstViewedAt": "<string>",
"colorPaletteUuid": "<string>",
"spacePath": "<string>",
"spaceSlug": "<string>",
"description": "<string>",
"parameters": {},
"config": {
"isDateZoomDisabled": true,
"requiredFiltersNote": "<string>",
"dateZoomConfig": {
"tileTargets": {},
"controls": [
{
"name": "<string>",
"uuid": "<string>",
"hidden": true
}
]
},
"dateZoomGranularities": [],
"parameterOrder": [
"<string>"
],
"pinnedParameters": [
"<string>"
],
"isAddFilterDisabled": true
},
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"deletedAt": "2023-11-07T05:31:56Z",
"deletedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
}
}
}
],
"spaces": [
{
"data": {
"name": "<string>",
"slug": "<string>",
"uuid": "<string>",
"organizationUuid": "<string>",
"projectUuid": "<string>",
"inheritParentPermissions": true,
"pinnedListUuid": "<string>",
"pinnedListOrder": 123,
"parentSpaceUuid": "<string>",
"path": "<string>",
"appCount": 123,
"childSpaceCount": 123,
"dashboardCount": 123,
"chartCount": 123,
"deletedBy": {
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>"
},
"deletedAt": "2023-11-07T05:31:56Z"
}
}
],
"dataApps": [
{
"data": {
"name": "<string>",
"uuid": "<string>"
}
}
],
"sqlCharts": [
{
"data": {
"spacePath": "<string>",
"spaceSlug": "<string>",
"description": "<string>",
"name": "<string>",
"projectUuid": "<string>",
"slug": "<string>",
"oldUuid": "<string>",
"uuid": "<string>"
}
}
]
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Body
application/json
Construct a type with the properties of T except for those in type K.
Available options:
line, horizontal_bar, vertical_bar, scatter, area, mixed, pie, table, big_number, funnel, custom, treemap, gauge, map, sankey, data_app_viz This AnyType is an alias for any
The goal is to make it easier to identify any type in the codebase
without having to eslint-disable all the time
These are only used on legacy any types, don't use it for new types.
This is added on a separate file to avoid circular dependencies.
Available options:
sql_chart Construct a type with a set of properties K of type T
Was this page helpful?
āI