Charts
promoteChartDiff
API
My Account
- Overview
- GETGetAuthenticatedUser
- POSTRegisterUser
- PUTCreateEmailOneTimePasscode
- GETGetEmailVerificationStatus
- GETListMyAvailableOrganizations
- POSTJoinOrganization
- DELDeleteMe
- GETcreateWarehouseCredentials
- POSTupdateWarehouseCredentials
- DELdeleteWarehouseCredentials
- PATCHupdateWarehouseCredentials
- GETgetLoginOptions
- PATCHRotate personal access token
Organizations
- Overview
- GETGetMyOrganization
- PUTCreateOrganization
- PATCHUpdateMyOrganization
- DELDeleteMyOrganization
- GETListOrganizationProjects
- GETListOrganizationMembers
- GETGetOrganizationMemberByUuid
- DELDeleteOrganizationMember
- GETListOrganizationEmailDomains
- PATCHUpdateOrganizationEmailDomains
- GETListGroupsInOrganization
- POSTCreateGroupInOrganization
Projects
- Overview
- GETGetExplores
- PUTSetExplores
- GETGetExplore
- POSTCompileQuery
- POSTDownloadCsvFromExplore
- GETGetProject
- GETListChartsInProject
- GETListChartSummariesInProject `Deprecated`
- GETListSpacesInProject
- GETGetProjectAccessList
- POSTCalculateTotalFromQuery
- GETgetUserWarehouseCredentialsPreference
- PATCHupdateUserWarehouseCredentialsPreference
- GETgetCustomMetrics
- PATCHupdateProjectMetadata
- DELdeleteProjectSemanticLayerConnection
- PATCHupdateProjectSemanticLayerConnection
- GETgetDashboards
- POSTcreateDashboard
- PATCHupdateDashboards
- POSTcreatePreview
- PATCHPatch apiv1projects schedulersettings
- GETgetTags
- POSTcreateTag
- DELdeleteTag
- PATCHupdateTag
- GETgetChartsAsCode
- GETgetDashboardsAsCode
- POSTupsertChartAsCode
- POSTupsertDashboardAsCode
- GETGetLatestValidationResults
- POSTValidateProject
- DELDeleteValidationDismiss
Roles & Permissions
- PATCHUpdateOrganizationMember
- POSTCreateSpaceInProject
- GETGet apiv1projects access
- POSTGetProjectAccessList
- GETGetProjectMemberAccess
- DELRevokeProjectAccessForUser
- PATCHGrantProjectAccessToUser
- PATCHUpdateSpace
- POSTAddSpaceUserAccess
- DELRevokeSpaceAccessForUser
- POSTAddSpaceGroupAccess
- DELRevokeGroupSpaceAccess
Catalog
- GETgetCatalog
- GETgetMetadata
- GETgetAnalytics
- GETgetAnalyticsField
- GETgetMetricsCatalog
- GETgetMetric
- GETgetMetricsWithTimeDimensions
- GETgetSegmentDimensions
- POSTaddCategoryToCatalogItem
- DELremoveCategoryFromCatalogItem
- PATCHupdateCatalogItemIcon
- GETgetMetricsTree
- POSTcreateMetricsTreeEdge
- DELdeleteMetricsTreeEdge
Exports
Git Integration
User Groups
Metrics Explorer
Notifications
Charts
Schedulers
Share links
SSH Keypairs
Charts
promoteChartDiff
Get diff from chart to promote
GET
/
api
/
v1
/
saved
/
{chartUuid}
/
promoteDiff
{
"results": {
"charts": [
{
"data": {
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"spaceName": "<string>",
"spaceUuid": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"pinnedListUuid": "<string>",
"dashboardUuid": "<string>",
"dashboardName": "<string>",
"slug": "<string>",
"tableName": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"pinnedListOrder": 123,
"metricQuery": {
"metadata": {
"hasADateDimension": {
"name": "<string>",
"label": "<string>"
}
},
"timezone": "<string>",
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123,
"binWidth": 123,
"customRange": [
{
"to": 123,
"from": 123
}
]
}
],
"additionalMetrics": [
{
"label": "<string>",
"type": "percentile",
"description": "<string>",
"sql": "<string>",
"hidden": true,
"round": 123,
"compact": "thousands",
"format": "km",
"table": "<string>",
"name": "<string>",
"index": 123,
"filters": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true
}
],
"baseDimensionName": "<string>",
"uuid": "<string>",
"percentile": 123,
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW"
}
}
],
"tableCalculations": [
{
"type": "number",
"format": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW"
},
"sql": "<string>",
"displayName": "<string>",
"name": "<string>",
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>"
}
],
"filters": {
"tableCalculations": {
"or": [
"<any>"
],
"id": "<string>"
},
"metrics": {
"or": [
"<any>"
],
"id": "<string>"
},
"dimensions": {
"or": [
"<any>"
],
"id": "<string>"
}
},
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>"
},
"pivotConfig": {
"columns": [
"<string>"
]
},
"chartConfig": {
"config": {
"comparisonLabel": "<string>",
"flipColors": true,
"comparisonFormat": "raw",
"showComparison": true,
"showBigNumberLabel": true,
"selectedField": "<string>",
"style": "thousands",
"label": "<string>"
},
"type": "big_number"
},
"tableConfig": {
"columnOrder": [
"<string>"
]
},
"colorPalette": [
"<string>"
],
"oldUuid": "<string>",
"spaceSlug": "<string>"
},
"action": "no changes"
}
],
"dashboards": [
{
"data": {
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"spaceName": "<string>",
"spaceUuid": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"pinnedListUuid": "<string>",
"slug": "<string>",
"dashboardVersionId": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"tiles": [
{
"uuid": "<string>",
"type": "saved_chart",
"x": 123,
"y": 123,
"h": 123,
"w": 123,
"tabUuid": "<string>",
"properties": {
"chartSlug": "<string>",
"lastVersionChartKind": "line",
"chartName": "<string>",
"belongsToDashboard": true,
"savedChartUuid": "<string>",
"hideTitle": true,
"title": "<string>"
}
}
],
"filters": {
"tableCalculations": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
],
"metrics": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
],
"dimensions": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
]
},
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"views": 123,
"firstViewedAt": "2023-11-07T05:31:56Z",
"pinnedListOrder": 123,
"tabs": [
{
"order": 123,
"name": "<string>",
"uuid": "<string>"
}
],
"config": {
"isDateZoomDisabled": true
},
"spaceSlug": "<string>"
},
"action": "no changes"
}
],
"spaces": [
{
"data": {
"name": "<string>",
"uuid": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"pinnedListUuid": "<string>",
"slug": "<string>",
"isPrivate": true,
"access": [
"<string>"
],
"pinnedListOrder": 123,
"chartCount": 123,
"dashboardCount": 123
},
"action": "no changes"
}
]
},
"status": "ok"
}
Path Parameters
chartUuid for the chart to check diff
Response
200
application/json
Success
From T, pick a set of properties whose keys are in the union K
Available options:
no changes
, create
, update
, delete
From T, pick a set of properties whose keys are in the union K
Make all properties in T required
Available options:
saved_chart
Available options:
no changes
, create
, update
, delete
From T, pick a set of properties whose keys are in the union K
Available options:
no changes
, create
, update
, delete
Available options:
ok
{
"results": {
"charts": [
{
"data": {
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"spaceName": "<string>",
"spaceUuid": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"pinnedListUuid": "<string>",
"dashboardUuid": "<string>",
"dashboardName": "<string>",
"slug": "<string>",
"tableName": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"pinnedListOrder": 123,
"metricQuery": {
"metadata": {
"hasADateDimension": {
"name": "<string>",
"label": "<string>"
}
},
"timezone": "<string>",
"customDimensions": [
{
"id": "<string>",
"name": "<string>",
"table": "<string>",
"type": "bin",
"dimensionId": "<string>",
"binType": "fixed_number",
"binNumber": 123,
"binWidth": 123,
"customRange": [
{
"to": 123,
"from": 123
}
]
}
],
"additionalMetrics": [
{
"label": "<string>",
"type": "percentile",
"description": "<string>",
"sql": "<string>",
"hidden": true,
"round": 123,
"compact": "thousands",
"format": "km",
"table": "<string>",
"name": "<string>",
"index": 123,
"filters": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"fieldRef": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true
}
],
"baseDimensionName": "<string>",
"uuid": "<string>",
"percentile": 123,
"formatOptions": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW"
}
}
],
"tableCalculations": [
{
"type": "number",
"format": {
"type": "default",
"round": 123,
"separator": "default",
"currency": "<string>",
"compact": "thousands",
"prefix": "<string>",
"suffix": "<string>",
"timeInterval": "RAW"
},
"sql": "<string>",
"displayName": "<string>",
"name": "<string>",
"index": 123
}
],
"limit": 123,
"sorts": [
{
"descending": true,
"fieldId": "<string>"
}
],
"filters": {
"tableCalculations": {
"or": [
"<any>"
],
"id": "<string>"
},
"metrics": {
"or": [
"<any>"
],
"id": "<string>"
},
"dimensions": {
"or": [
"<any>"
],
"id": "<string>"
}
},
"metrics": [
"<string>"
],
"dimensions": [
"<string>"
],
"exploreName": "<string>"
},
"pivotConfig": {
"columns": [
"<string>"
]
},
"chartConfig": {
"config": {
"comparisonLabel": "<string>",
"flipColors": true,
"comparisonFormat": "raw",
"showComparison": true,
"showBigNumberLabel": true,
"selectedField": "<string>",
"style": "thousands",
"label": "<string>"
},
"type": "big_number"
},
"tableConfig": {
"columnOrder": [
"<string>"
]
},
"colorPalette": [
"<string>"
],
"oldUuid": "<string>",
"spaceSlug": "<string>"
},
"action": "no changes"
}
],
"dashboards": [
{
"data": {
"name": "<string>",
"description": "<string>",
"uuid": "<string>",
"spaceName": "<string>",
"spaceUuid": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"pinnedListUuid": "<string>",
"slug": "<string>",
"dashboardVersionId": 123,
"updatedAt": "2023-11-07T05:31:56Z",
"tiles": [
{
"uuid": "<string>",
"type": "saved_chart",
"x": 123,
"y": 123,
"h": 123,
"w": 123,
"tabUuid": "<string>",
"properties": {
"chartSlug": "<string>",
"lastVersionChartKind": "line",
"chartName": "<string>",
"belongsToDashboard": true,
"savedChartUuid": "<string>",
"hideTitle": true,
"title": "<string>"
}
}
],
"filters": {
"tableCalculations": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
],
"metrics": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
],
"dimensions": [
{
"values": [
"<any>"
],
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>"
},
"settings": "<any>",
"disabled": true,
"required": true,
"label": "<string>",
"tileTargets": {}
}
]
},
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"views": 123,
"firstViewedAt": "2023-11-07T05:31:56Z",
"pinnedListOrder": 123,
"tabs": [
{
"order": 123,
"name": "<string>",
"uuid": "<string>"
}
],
"config": {
"isDateZoomDisabled": true
},
"spaceSlug": "<string>"
},
"action": "no changes"
}
],
"spaces": [
{
"data": {
"name": "<string>",
"uuid": "<string>",
"projectUuid": "<string>",
"organizationUuid": "<string>",
"pinnedListUuid": "<string>",
"slug": "<string>",
"isPrivate": true,
"access": [
"<string>"
],
"pinnedListOrder": 123,
"chartCount": 123,
"dashboardCount": 123
},
"action": "no changes"
}
]
},
"status": "ok"
}