Reference
- GETGet apiv1snowflakessois authenticated
- GETCheck Databricks OAuth authentication
- GETGet apiv1projects validate
- POSTPost apiv1projects validate
- DELDelete apiv1projects validate
- GETGet apiv1analyticsuser activity
- POSTPost apiv1analyticsuser activity download
- GETGet unused content
- GETGet apiv1projects spaces
- POSTPost apiv1projects rename
- POSTPost apiv1projects renamechart
- GETGet apiv1projects renamechart fields
- GETGet apiv1projects
- GETGet apiv1projects charts
- GETGet apiv1projects chart summariesdeprecated
- GETGet apiv1projects groupaccesses
- POSTPost apiv1projects calculate total
- POSTPost apiv1projects calculate subtotals
- GETGet apiv1projects user credentials
- PATCHPatch apiv1projects user credentials
- GETGet apiv1projects custom metrics
- PATCHPatch apiv1projects metadata
- GETGet apiv1projects dashboards
- POSTPost apiv1projects dashboards
- PATCHPatch apiv1projects dashboards
- POSTPost apiv1projects dashboardswith charts
- POSTPost apiv1projects createpreview
- PATCHPatch apiv1projects schedulersettings
- GETGet apiv1projects tags
- POSTPost apiv1projects tags
- DELDelete apiv1projects tags
- PATCHPatch apiv1projects tags
- PUTPut apiv1projects tagsyaml
- GETGet apiv1projects chartscode
- GETGet apiv1projects dashboardscode
- POSTPost apiv1projects charts code
- GETGet SQL charts as code
- POSTUpsert SQL chart as code
- POSTPost apiv1projects dashboards code
- POSTPost apiv1projects dbt cloudwebhook
- POSTPost apiv1projects refresh
- GETGet apiv1projects compile logs
- GETGet compilation log for a specific job
- GETGet apiv1projects explores
- PUTPut apiv1projects explores
- GETGet apiv1projects explores 1
- POSTPost apiv1projects explores compilequery
- POSTPost apiv1projects explores downloadcsv
- GETGet apiv1bigqueryssodatasets
- GETGet apiv1bigqueryssois authenticated
- GET
A valid request URL is required to generate request examples{
"results": {
"slug": "<string>",
"access": [
{
"hasDirectAccess": true,
"role": "viewer",
"email": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>",
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer"
}
],
"isPrivate": true,
"tabs": [
{
"order": 123,
"name": "<string>",
"uuid": "<string>"
}
],
"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
},
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
],
"metrics": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
],
"dimensions": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"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",
"name": "<string>",
"uuid": "<string>",
"dashboardVersionId": 123,
"projectUuid": "<string>",
"organizationUuid": "<string>",
"config": {
"isDateZoomDisabled": true,
"pinnedParameters": [
"<string>"
]
},
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"parameters": {},
"description": "<string>"
},
"status": "ok"
}Post apiv1projects dashboardswith charts
A valid request URL is required to generate request examples{
"results": {
"slug": "<string>",
"access": [
{
"hasDirectAccess": true,
"role": "viewer",
"email": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"userUuid": "<string>",
"inheritedFrom": "organization",
"inheritedRole": "member",
"projectRole": "viewer"
}
],
"isPrivate": true,
"tabs": [
{
"order": 123,
"name": "<string>",
"uuid": "<string>"
}
],
"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
},
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
],
"metrics": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"singleValue": true,
"label": "<string>",
"tileTargets": {}
}
],
"dimensions": [
{
"operator": "isNull",
"id": "<string>",
"target": {
"tableName": "<string>",
"fieldId": "<string>",
"fallbackType": "string",
"isSqlColumn": true
},
"values": [
"<unknown>"
],
"settings": "<unknown>",
"disabled": true,
"required": true,
"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",
"name": "<string>",
"uuid": "<string>",
"dashboardVersionId": 123,
"projectUuid": "<string>",
"organizationUuid": "<string>",
"config": {
"isDateZoomDisabled": true,
"pinnedParameters": [
"<string>"
]
},
"updatedByUser": {
"userUuid": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"parameters": {},
"description": "<string>"
},
"status": "ok"
}Path Parameters
Body
From T, pick a set of properties whose keys are in the union K
- Option 1
- Option 2
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
big_number Show child attributes
Show child attributes
raw, percentage thousands, millions, billions, trillions, kilobytes, megabytes, gigabytes, terabytes, petabytes, kibibytes, mebibytes, gibibytes, tebibytes, pebibytes Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
number, string, date, timestamp, boolean Show child attributes
Show child attributes
default, percent, currency, number, id, date, timestamp, bytes_si, bytes_iec, custom default, commaPeriod, spacePeriod, periodComma, noSeparatorPeriod thousands, millions, billions, trillions, kilobytes, megabytes, gigabytes, terabytes, petabytes, kibibytes, mebibytes, gibibytes, tebibytes, pebibytes RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween 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.
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.
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween 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.
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.
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween 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.
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.
Show child attributes
Show child attributes
RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM previousPeriod Show child attributes
Show child attributes
Show child attributes
Show child attributes
From T, pick a set of properties whose keys are in the union K
Show child attributes
Show child attributes
Show child attributes
Show child attributes
default, percent, currency, number, id, date, timestamp, bytes_si, bytes_iec, custom default, commaPeriod, spacePeriod, periodComma, noSeparatorPeriod thousands, millions, billions, trillions, kilobytes, megabytes, gigabytes, terabytes, petabytes, kibibytes, mebibytes, gibibytes, tebibytes, pebibytes RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM - Option 1
- Option 2
Show child attributes
Show child attributes
bin fixed_number, fixed_width, custom_range Show child attributes
Show child attributes
percentile, average, count, count_distinct, sum, min, max, percent_of_previous, percent_of_total, running_total, number, median, string, date, timestamp, boolean thousands, millions, billions, trillions, kilobytes, megabytes, gigabytes, terabytes, petabytes, kibibytes, mebibytes, gibibytes, tebibytes, pebibytes km, mi, usd, gbp, eur, jpy, dkk, id, percent Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween 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.
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.
Show child attributes
Show child attributes
default, percent, currency, number, id, date, timestamp, bytes_si, bytes_iec, custom default, commaPeriod, spacePeriod, periodComma, noSeparatorPeriod thousands, millions, billions, trillions, kilobytes, megabytes, gigabytes, terabytes, petabytes, kibibytes, mebibytes, gibibytes, tebibytes, pebibytes RAW, YEAR, QUARTER, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, MILLISECOND, DAY_OF_WEEK_INDEX, DAY_OF_MONTH_NUM, DAY_OF_YEAR_NUM, WEEK_NUM, MONTH_NUM, QUARTER_NUM, YEAR_NUM, DAY_OF_WEEK_NAME, MONTH_NAME, QUARTER_NAME, HOUR_OF_DAY_NUM, MINUTE_OF_HOUR_NUM Response
Created
Show child attributes
Show child attributes
Show child attributes
Show child attributes
viewer, editor, admin organization, project, group, space_group member, viewer, interactive_viewer, editor, developer, admin viewer, interactive_viewer, editor, developer, admin Show child attributes
Show child attributes
Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween Show child attributes
Show child attributes
string, number, timestamp, date, boolean 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.
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.
Construct a type with a set of properties K of type T
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, timestamp, date, boolean Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween 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.
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.
Construct a type with a set of properties K of type T
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, timestamp, date, boolean Show child attributes
Show child attributes
isNull, notNull, equals, notEquals, startsWith, endsWith, include, doesNotInclude, lessThan, lessThanOrEqual, greaterThan, greaterThanOrEqual, inThePast, notInThePast, inTheNext, inTheCurrent, notInTheCurrent, inBetween, notInBetween Show child attributes
Show child attributes
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.
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.
Construct a type with a set of properties K of type T
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, timestamp, date, boolean Make all properties in T required
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
saved_chart Show child attributes
Show child attributes
line, horizontal_bar, vertical_bar, scatter, area, mixed, pie, table, big_number, funnel, custom, treemap, gauge, map ok Was this page helpful?