Lightdash Projects API
Projects belong to a single organization. These routes allow users to manage their projects, browse content, and execute queries. Users inside an organization might have access to a project from an organization-level role or they might be granted access to a project directly.
Lightdash Projects API is one of 50 APIs that Lightdash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 8 JSON Schema definitions.
Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 8 JSON Schemas.
This API exposes 137 operations across 114 paths, and defines 809 schemas. It is described by OpenAPI 3.0.0, at version 0.3156.1.
Requests are made against a single base URL, /.
137 operations
114 paths
809 schemas
6 DELETE60 GET17 PATCH50 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Lightdash Projects API declares
2 security schemes
for authenticating requests.
An API key is passed in the cookie as connect.sid (session_cookie).
An API key is passed in the header as Authorization (api_key).
api_key— Value should be 'ApiKey '
Paths & Operations 137
Across 114 paths, the API surfaces 137 operations — 6 DELETE, 60 GET, 17 PATCH, 50 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Projects 137
Projects belong to a single organization. These routes allow users to manage their projects, browse content, and execute queries. Users inside an organization might have access to…
GET
/api/v1/snowflake/sso/is-authenticated
Check Snowflake SSO authentication
GET
/api/v1/databricks/sso/is-authenticated
Check Databricks OAuth authentication
GET
/api/v1/projects/{projectUuid}/aiAgents
POST
/api/v1/projects/{projectUuid}/aiAgents
GET
/api/v1/projects/{projectUuid}/aiAgents/preferences
POST
/api/v1/projects/{projectUuid}/aiAgents/preferences
DELETE
/api/v1/projects/{projectUuid}/aiAgents/preferences
GET
/api/v1/projects/{projectUuid}/aiAgents/mcpServers
POST
/api/v1/projects/{projectUuid}/aiAgents/mcpServers
GET
/api/v1/projects/{projectUuid}/aiAgents/mcpServers/github/availability
POST
/api/v1/projects/{projectUuid}/aiAgents/mcpServers/github/connect
GET
/api/v1/projects/{projectUuid}/aiAgents/mcpServers/{mcpServerUuid}/tools
POST
/api/v1/projects/{projectUuid}/aiAgents/mcpServers/{mcpServerUuid}/tools/refresh
POST
/api/v1/projects/{projectUuid}/aiAgents/mcpServers/{mcpServerUuid}/oauth/start
POST
/api/v1/projects/{projectUuid}/aiAgents/mcpServers/{mcpServerUuid}/oauth/disconnect
GET
/api/v1/projects/{projectUuid}/aiAgents/threads
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}
PATCH
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}
DELETE
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/mcpServers
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/mcpServers/{mcpServerUuid}/tools
PATCH
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/mcpServers/{mcpServerUuid}/tools
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/models
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/suggestions
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluateReadiness
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/verified-artifacts
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/verified-questions
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/pull-request
Get AI agent thread pull request
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/messages
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/tool-calls/{toolCallId}/sql-approval
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/stream
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/generate
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/generate-title
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/clone/{promptUuid}
PATCH
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/messages/{messageUuid}/savedQuery
PATCH
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/messages/{messageUuid}/feedback
POST
/api/v1/projects/{projectUuid}/aiAgents/explore-access-summary
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}/viz-query
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/shares
POST
/api/v1/projects/{projectUuid}/aiAgents/thread-shares/{aiThreadShareUuid}/clone
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}/charts/{chartIndex}/viz-query
PATCH
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}/savedDashboard
PATCH
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/artifacts/{artifactUuid}/versions/{versionUuid}/verified
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}/run
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}
PATCH
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}
DELETE
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}/runs
GET
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}/runs/{runUuid}
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/evaluations/{evalUuid}/append
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/append-instruction
POST
/api/v1/projects/{projectUuid}/aiAgents/{agentUuid}/threads/{threadUuid}/messages/{promptUuid}/revert-change
POST
/api/v1/projects/{projectUuid}/validate
Validate project
GET
/api/v1/projects/{projectUuid}/validate
Get validation results
DELETE
/api/v1/projects/{projectUuid}/validate/{validationIdOrUuid}
Dismiss validation error
POST
/api/v1/projects/{projectUuid}/validate/chart/{chartUuid}
Validate specific chart
POST
/api/v1/projects/{projectUuid}/validate/dashboard/{dashboardUuid}
Validate specific dashboard
GET
/api/v1/analytics/user-activity/{projectUuid}
Get user activity
POST
/api/v1/analytics/user-activity/{projectUuid}/download
Download user activity CSV
GET
/api/v1/analytics/user-activity/{projectUuid}/download-activity
Get download activity log
GET
/api/v1/projects/{projectUuid}/spaces
List spaces in project
POST
/api/v1/projects/{projectUuid}/rename
Rename resources
POST
/api/v1/projects/{projectUuid}/rename/preview
Preview rename
POST
/api/v1/projects/{projectUuid}/rename/chart/{chartUuid}
Rename chart
GET
/api/v1/projects/{projectUuid}/rename/chart/{chartUuid}/fields
Get chart fields for rename
POST
/api/v1/projects/{projectUuid}/rename/dashboard/{dashboardUuid}
Rename dashboard filter
GET
/api/v1/projects/{projectUuid}/rename/dashboard/{dashboardUuid}/fields
Get dashboard fields for rename
GET
/api/v1/projects/{projectUuid}
Get project
GET
/api/v1/projects/{projectUuid}/charts
List charts in project
GET
/api/v1/projects/{projectUuid}/chart-summariesdeprecated
List chart summaries in project
GET
/api/v1/projects/{projectUuid}/access
List project access
POST
/api/v1/projects/{projectUuid}/access
Grant project access to user
GET
/api/v1/projects/{projectUuid}/user/{userUuid}deprecated
Get project member access
POST
/api/v1/projects/preview-data-timezone
Preview data timezone
PATCH
/api/v1/projects/{projectUuid}/access/{userUuid}deprecated
Update project access for user
DELETE
/api/v1/projects/{projectUuid}/access/{userUuid}deprecated
Revoke project access for user
GET
/api/v1/projects/{projectUuid}/groupAccesses
List project group accesses
POST
/api/v1/projects/{projectUuid}/sqlQuerydeprecated
Run SQL query
POST
/api/v1/projects/{projectUuid}/calculate-totaldeprecated
Calculate total from query
POST
/api/v1/projects/{projectUuid}/calculate-subtotalsdeprecated
Calculate subtotals from query
GET
/api/v1/projects/{projectUuid}/user-credentials
Get user warehouse credentials preference
GET
/api/v1/projects/{projectUuid}/user-warehouse-credentials
List project user warehouse credentials
PATCH
/api/v1/projects/{projectUuid}/user-credentials/{userWarehouseCredentialsUuid}
Update user warehouse credentials preference
GET
/api/v1/projects/{projectUuid}/custom-metricsdeprecated
List custom metrics
PATCH
/api/v1/projects/{projectUuid}/metadata
Update project metadata
PATCH
/api/v1/projects/{projectUuid}/hasDefaultUserSpaces
Update default user spaces setting
GET
/api/v1/projects/{projectUuid}/table-groups
Get project color palette
PUT
/api/v1/projects/{projectUuid}/table-groups
Replace project table groups
GET
/api/v1/projects/{projectUuid}/colorPalette
PATCH
/api/v1/projects/{projectUuid}/colorPalette
Update project color palette
GET
/api/v1/projects/{projectUuid}/dashboards
List dashboards
POST
/api/v1/projects/{projectUuid}/dashboards
Create dashboard
PATCH
/api/v1/projects/{projectUuid}/dashboards
Update dashboards
POST
/api/v1/projects/{projectUuid}/dashboards/with-charts
Create dashboard with charts
POST
/api/v1/projects/{projectUuid}/createPreview
Create project preview
GET
/api/v1/projects/{projectUuid}/upstreamDiff
Get upstream diff
GET
/api/v1/projects/{projectUuid}/previews-config
Get preview expiration settings
PATCH
/api/v1/projects/{projectUuid}/previews-config
Update preview expiration settings
PATCH
/api/v1/projects/{projectUuid}/schedulerSettings
Update scheduler settings
PATCH
/api/v1/projects/{projectUuid}/queryTimezoneSettings
Update query timezone settings
POST
/api/v1/projects/{projectUuid}/tags
Create tag
GET
/api/v1/projects/{projectUuid}/tags
List tags
DELETE
/api/v1/projects/{projectUuid}/tags/{tagUuid}
Delete tag
PATCH
/api/v1/projects/{projectUuid}/tags/{tagUuid}
Update tag
PUT
/api/v1/projects/{projectUuid}/tags/yaml
Replace YAML tags
GET
/api/v1/projects/{projectUuid}/charts/code
List charts as code
GET
/api/v1/projects/{projectUuid}/dashboards/code
List dashboards as code
POST
/api/v1/projects/{projectUuid}/charts/{slug}/code
Upsert chart as code
GET
/api/v1/projects/{projectUuid}/sqlCharts/code
Get SQL charts as code
POST
/api/v1/projects/{projectUuid}/sqlCharts/{slug}/code
Upsert SQL chart as code
POST
/api/v1/projects/{projectUuid}/dashboards/{slug}/code
Upsert dashboard as code
POST
/api/v1/projects/{projectUuid}/dbt-cloud/webhook
Handle dbt Cloud webhook
POST
/api/v1/projects/{projectUuid}/refresh
Refresh project
POST
/api/v1/projects/{projectUuid}/pre-aggregates/refresh
Refresh project pre-aggregates
POST
/api/v1/projects/{projectUuid}/pre-aggregates/definitions/{preAggregateDefinitionName}/refresh
Refresh pre-aggregate by definition name
GET
/api/v1/projects/{projectUuid}/content-verification
List verified content
GET
/api/v1/projects/{projectUuid}/compile-logs
Get project compilation logs
GET
/api/v1/projects/{projectUuid}/compile-logs/job/{jobUuid}
Get compilation log for a specific job
PUT
/api/v1/projects/{projectUuid}/explores
Set explores
GET
/api/v1/projects/{projectUuid}/explores
List explores
GET
/api/v1/projects/{projectUuid}/explores/{exploreId}
Get explore
POST
/api/v1/projects/{projectUuid}/explores/{exploreId}/compileQuery
Compile query
POST
/api/v1/projects/{projectUuid}/explores/{exploreId}/preAggregateCheck
Check pre-aggregate
POST
/api/v1/projects/{projectUuid}/explores/{exploreId}/validateFormula
Validate formula
GET
/api/v1/projects/{projectUuid}/explores/{exploreId}/charts
List charts by explore
GET
/api/v1/bigquery/sso/datasets
Get BigQuery datasets
GET
/api/v1/bigquery/sso/projects
Get BigQuery projects
GET
/api/v1/bigquery/sso/is-authenticated
Check BigQuery authentication
GET
/api/v2/projects/{projectUuid}/defaults
Get project defaults
PUT
/api/v2/projects/{projectUuid}/defaults
Replace project defaults
Schemas 809
The contract defines 809 schemas that model the data the API accepts and returns. The most detailed are Dimension (37 properties), Metric (33 properties), Dashboard (27 properties), MapChart (26 properties). Each schema is shown below with its type and property counts.
FieldType.DIMENSION
string
OrganizationMemberRole
string
Exclude_ToolName.proposeChange_
string
Exclude from T those types that are assignable to U
AiAgentBaseToolCall
object
6 properties
6 required
ApiSuccess_AiModelOption-Array_
object
2 properties
2 required
DbtProjectType.GITHUB
string
ApiCreateAiAgent
ApiCreatePreviewResults
object
2 properties
2 required
ResolvedProjectColorPalette
object
5 properties
5 required
Pick_CompiledDimension.name-or-label-or-table_
object
From T, pick a set of properties whose keys are in the union K
MapHexbinSizingMode
string
ApiCreateAiMcpServer
object
6 properties
3 required
MarkLine
object
4 properties
1 required
AiMcpServerTool
object
10 properties
10 required
CompilationSource
string
Omit_Explore.unfilteredTables_
Construct a type with the properties of T except for those in type K.
DucklakeCatalogSqlite
ApiBigqueryDatasets
object
2 properties
2 required
OrderFieldsByStrategy
string
Omit_CreateDatabricksCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
FilterGroup
ApiErrorPayload
object
The Error object is returned from the api any time there is an error. The message contains
2 properties
2 required
ApiDataTimezonePreview
object
2 properties
2 required
NonNullable_Explore-at-warnings_
Exclude null and undefined from T
ApiPreAggregateCheckResponse
object
2 properties
2 required
ApiAiMcpGithubAvailabilityResponse
PivotReference
object
2 properties
1 required
Pick_Dashboard.uuid-or-name-or-description-or-updatedAt-or-projectUuid-or-updatedByUser-or-organizationUuid-or-spaceUuid-or-views-or-firstViewedAt-or-pinnedListUuid-or-pinnedListOrder_
object
From T, pick a set of properties whose keys are in the union K
12 properties
10 required
Pick_Dimension.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
AiAgentMcpServerToolUpdate
QueryWarning
object
3 properties
1 required
DashboardChartTileProperties
object
2 properties
2 required
PreAggregateSource
object
2 properties
2 required
DucklakeDataPathType.AZURE
string
ChartType
string
VizTableConfig
ValidationErrorType
string
FilterGroupInput
ApiAgentSuggestionsResponse
DucklakeDataPathAzure
DashboardLoomTileAsCode
ProjectMemberRole
string
PartialObjectDeep___91_x-string_93__58__description_63_-string-or-undefined--name_63_-string-or-undefined--tiles_63__58__40__type-DashboardTileTypes.SAVED_CHART-or-DashboardTileTypes.SQL_CHART--properties_58__title-string--chartName-string__-or-_type-DashboardTileTypes.MARKDOWN--properties_58__content-string--title-string__-or-_type-DashboardTileTypes.LOOM--properties_58__title-string__-or-_type-DashboardTileTypes.HEADING--properties_58__text-string__-or-_type-DashboardTileTypes.DATA_APP--properties_58__title-string___41_-Array-or-undefined__._recurseIntoArrays-true__
object
Same as PartialDeep, but accepts only objects as inputs. Internal helper for PartialDeep.
AiAgentToolResult
DucklakeDataPathS3
TreemapChart
object
10 properties
Record_string.Field-or-TableCalculation-or-CustomDimension-or-Metric_
object
Construct a type with a set of properties K of type T
DashboardDataAppTile
Record_string.Partial_PieChartValueOptions__
object
Construct a type with a set of properties K of type T
AgentSuggestionTool
string
CartesianSeriesType
string
CompiledDimension
DbtProjectType.MANIFEST
string
FrameBoundaryType
string
ApiSuccess__chips-AgentSuggestion-Array__
object
2 properties
2 required
UpdateProjectMember
object
1 property
1 required
Partial_PieChartValueOptions_
object
Make all properties in T optional
3 properties
ApiAgentReadinessScoreResponse
DucklakeDataPathType.GCS
string
ApiAiAgentThreadMessageVizQuery
object
3 properties
3 required
DashboardFilterRule
AthenaCredentials
ApiSuccess__updatedInstruction-string__
object
2 properties
2 required
ApiAiAgentEvaluationRunResponse
CacheMetadata
object
5 properties
1 required
Tag
object
7 properties
7 required
Pick_LightdashUser.userUuid-or-firstName-or-lastName_
object
From T, pick a set of properties whose keys are in the union K
AiAgentThreadSummary
object
8 properties
8 required
Pick_Explore.SummaryExploreFields_
object
From T, pick a set of properties whose keys are in the union K
9 properties
3 required
DucklakeCatalogDuckdb
ExploreWarningSummary
AiAgentVerifiedArtifact
object
10 properties
10 required
BinRange
object
2 properties
FilterGroupItem
PivotValue
object
2 properties
2 required
MetricOverrides
object
SortBy
array
LegendPlacement
string
High-level legend placement preset. Set to 'outsideRight' or 'outsideLeft' to render the legend beside the plot with reserved grid space. Undefined behaves lik…
MetadataCompletenessEvaluation
AiPromptContextItem
Filters
object
3 properties
Pick_SavedChart.name-or-description-or-tableName-or-metricQuery-or-pivotConfig-or-chartConfig-or-tableConfig-or-parameters_
object
From T, pick a set of properties whose keys are in the union K
8 properties
5 required
InlineError
object
2 properties
2 required
LineageNodeDependency
object
2 properties
2 required
Omit_ChartAsCode.chartConfig-or-description_
Construct a type with the properties of T except for those in type K.
ApiValidateResponse
object
2 properties
2 required
AdditionalMetric
object
23 properties
4 required
Record_string.LineageNodeDependency-Array_
object
Construct a type with a set of properties K of type T
ApiProjectCompileLogsResults
object
2 properties
1 required
Omit_CreateAthenaCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
UserWarehouseCredentials
object
7 properties
7 required
CreateTrinoCredentials
object
12 properties
8 required
JoinRelationship
string
AiMcpServerAuthType
string
ChartAsCode
Source
object
4 properties
3 required
FrameBoundary
object
2 properties
1 required
CreateDucklakeCatalogSqlite
object
2 properties
2 required
ApiRenameChartResponse
object
2 properties
2 required
CreateWarehouseCredentials
Pick_BaseAiAgent.uuid-or-projectUuid-or-organizationUuid-or-integrations-or-tags-or-name-or-description-or-createdAt-or-updatedAt-or-instruction-or-imageUrl-or-groupAccess-or-userAccess-or-spaceAccess-or-enableDataAccess-or-enableSelfImprovement-or-enableContentTools-or-version_
object
From T, pick a set of properties whose keys are in the union K
18 properties
18 required
MetricQuery
object
14 properties
7 required
Record_string.number_
object
Construct a type with a set of properties K of type T
CreateDashboardDataAppTile
ApiChartListResponse
object
2 properties
2 required
DashboardHeadingTile
PieChartValueLabel
string
OrFilterGroupInput
object
2 properties
1 required
ChartKind.VERTICAL_BAR
string
DashboardTile
Partial_CompleteCartesianChartLayout_
object
Make all properties in T optional
13 properties
ApiSqlQueryResults
object
2 properties
2 required
PieChart
object
14 properties
GroupValueRule
object
2 properties
2 required
MapFieldConfig
object
2 properties
ApiSuccess__decision-approved-or-rejected__
object
2 properties
2 required
ApiSuccess__question-string--uuid-string_-Array_
object
2 properties
2 required
WarehouseTypes.TRINO
string
Pick_CompiledDimension.label-or-name-or-table_
object
From T, pick a set of properties whose keys are in the union K
3 properties
3 required
TableCalculationTemplateType.WINDOW_FUNCTION
string
ApiDashboardAsCodeUpsertResponse
object
2 properties
2 required
ApiAiAgentModelOptionsResponse
ApiCalculateTotalResponse
object
2 properties
2 required
MetricQueryRequest
object
16 properties
7 required
SupportedDbtVersions
string
CartesianChartLayout
ApiRenameFieldsResponse
object
2 properties
2 required
Omit_SqlChartAsCode.config-or-description_
Construct a type with the properties of T except for those in type K.
AnyType
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 onl…
ApiAiMcpOAuthCredentialRequest
object
1 property
ApiSuccessEmpty
object
2 properties
1 required
ApiAiMcpServerListResponse
TimeFrames
string
ApiSuccess_AiAgentMessageUser_AiAgentUser__
object
2 properties
2 required
ApiSuccess_AiAgentEvaluation_
object
2 properties
2 required
PivotChartLayout
object
5 properties
1 required
PreAggregateMissReason.NO_ACTIVE_MATERIALIZATION
string
ApiCreateAiAgentResponse
object
2 properties
2 required
SqlTableCalculation
AiChartRuntimeOverrides
object
Runtime state captured at pin time for a chart context. When a user pins a chart from a dashboard view, these are the dashboard-level overrides that were appli…
3 properties
ApiSuccess_AiArtifactTSOACompat_
object
2 properties
2 required
ApiSuccess__errors-CreateDashboardValidation-Array__
object
2 properties
2 required
PreAggregateMissReason.CUSTOM_SQL_METRIC
string
FixedNumberBinDimension
object
7 properties
7 required
Pick_UpdatedByUser.userUuid_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
DownloadActivityResults
object
2 properties
2 required
ChartType.SANKEY
string
ApiRevertChangeResponse
AiAgentBaseToolResult
object
5 properties
5 required
DbtProjectEnvironmentVariable
object
2 properties
2 required
ApiRenameBody
object
5 properties
3 required
UpdatePreviewExpirationProjectSettings
object
2 properties
2 required
ApiProjectAccessListResponse
object
2 properties
2 required
GaugeSection
object
5 properties
3 required
ApiAiAgentEvaluationSummaryListResponse
ValidationSourceType
string
Record_string.DashboardParameterValue_
object
Construct a type with a set of properties K of type T
DashboardDAO
DucklakeCatalog
ReadinessScore
object
6 properties
6 required
Pick_CreateRedshiftCredentials.Exclude_keyofCreateRedshiftCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
18 properties
5 required
WarehouseTypes
string
MapChartConfig
object
2 properties
1 required
ApiDashboardAsCodeListResponse
object
2 properties
2 required
VizCartesianChartConfig
ApiSuccess__jobIds-string-Array__
object
2 properties
2 required
DucklakeDataPathType.LOCAL
string
GroupByColumn
object
1 property
1 required
DucklakeCatalogType.DUCKDB
string
ApiAiAgentThreadMessageCreateRequest
object
3 properties
1 required
Series
object
14 properties
2 required
Pick_ValidationErrorDashboardResponse.error-or-errorType-or-fieldName-or-name-or-projectUuid-or-dashboardUuid-or-chartName-or-source_
object
From T, pick a set of properties whose keys are in the union K
8 properties
4 required
CustomFormat
object
9 properties
1 required
ChartType.FUNNEL
string
ChartKind.PIE
string
CreateBigqueryCredentials
object
16 properties
4 required
Omit_CreateDucklakeDataPathGcs.hmacKeyId-or-hmacSecret_
Construct a type with the properties of T except for those in type K.
FiltersInput
object
3 properties
DuckdbCredentials
ApiAiAgentThreadMessageCreateResponse
Pick_ChartAsCode.Exclude_keyofChartAsCode.chartConfig-or-description__
object
From T, pick a set of properties whose keys are in the union K
15 properties
6 required
TableCalculationTemplate
Record_string.FieldSetDefinition_
object
Construct a type with a set of properties K of type T
CreateRedshiftCredentials
Omit_CreatePostgresCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
ApiAiAgentEvaluationRunSummaryListResponse
ChartType.BIG_NUMBER
string
PreAggregateDef
object
9 properties
3 required
TemplateTableCalculation
WarehouseTypes.POSTGRES
string
FieldSetDefinition
object
1 property
1 required
PromotedSpace
DashboardSqlChartTileProperties
object
2 properties
2 required
Pick_CreateDatabricksCredentials.Exclude_keyofCreateDatabricksCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
10 properties
4 required
ConditionalFormattingConfig
SourcePosition
object
2 properties
2 required
PartialDeep_DashboardAsCodeLanguageMap._recurseIntoArrays-true__
Create a type from another type with all keys and nested keys set to optional. Use-cases: - Merging a default settings/config object with another object, the s…
ChartType.GAUGE
string
Record_string.Record_string.string-or-string-Array__
object
Construct a type with a set of properties K of type T
Pick_FilterRule.Exclude_keyofFilterRule.id__
object
From T, pick a set of properties whose keys are in the union K
7 properties
2 required
ValuesColumn
object
2 properties
2 required
Pick_MetricQuery.Exclude_keyofMetricQuery.filters__
object
From T, pick a set of properties whose keys are in the union K
13 properties
6 required
Record_string.CompiledDimension_
object
Construct a type with a set of properties K of type T
BigNumberConfig
object
2 properties
1 required
ExploreWarningReport
object
3 properties
3 required
ApiUpstreamDiffResults
object
2 properties
2 required
AiAgentEvaluationPrompt
Pick_CreateDucklakeCatalogPostgres.Exclude_keyofCreateDucklakeCatalogPostgres.user-or-password__
object
From T, pick a set of properties whose keys are in the union K
4 properties
4 required
SnowflakeCredentials
ApiCalculateSubtotalsResponse
object
2 properties
2 required
DuplicateDashboardParams
object
2 properties
2 required
VizIndexType
string
ApiSuccess_AiAgentEvaluationRun_
object
2 properties
2 required
ConditionalFormattingConfigWithColorRange
object
4 properties
3 required
CompilationHistoryReport
object
7 properties
7 required
CreateDashboardHeadingTile
DatabricksCredentials
DashboardFilterValidationErrorType
string
FunnelChartLegendPosition
string
VizColumnsConfig
object
Pick_SavedChart.Exclude_keyofSavedChart.inheritsFromOrgOrProject-or-access__
object
From T, pick a set of properties whose keys are in the union K
26 properties
20 required
Required_CreateDashboardTileBase_
object
Make all properties in T required
7 properties
6 required
ApiSuccess_AiAgentMcpServerTool-Array_
object
2 properties
2 required
CustomDimension
DashboardParameterValue
object
2 properties
2 required
ApiGetProjectMemberResponse
object
2 properties
2 required
ExploreType
string
AiAgentToolCallMcpServer
AiAgentEvaluationRunSummary
object
7 properties
7 required
ValidationResponseBase
object
9 properties
7 required
ApiAiAgentThreadPullRequestResponse
Pick_CreateAthenaCredentials.type_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
ApiRefreshResults
object
1 property
1 required
ApiCreateDashboardWithChartsResponse
object
2 properties
2 required
ApiExecuteAsyncMetricQueryResults
ApiSuccess_AiMcpServerTool-Array_
object
2 properties
2 required
Pick_AiAgentEvaluation.evalUuid_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
CreateDucklakeDataPath
TrinoCredentials
DbtNoneProjectConfig
object
5 properties
1 required
ChartType.TABLE
string
ApiUpdateDashboardsResponse
object
2 properties
2 required
MapTileBackground
string
ProjectGroupAccess
object
3 properties
3 required
AiAgentMessageUser_AiAgentUser_
object
7 properties
7 required
FieldType.METRIC
string
SpaceMemberRole
string
ApiSuccess_AiAgentThreadShare_
object
2 properties
2 required
DucklakeCatalogType.POSTGRES
string
Pick_ValidationResponse.error-or-createdAt-or-validationUuid-or-validationId_
object
From T, pick a set of properties whose keys are in the union K
4 properties
4 required
DashboardSqlChartTileAsCode
Pick_CreateRedshiftCredentials-or-CreatePostgresCredentials-or-CreateSnowflakeCredentials-or-CreateTrinoCredentials-or-CreateClickhouseCredentials.type-or-user_
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
Pick_Tag.name-or-color_
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
CartesianSeriesType.BAR
string
WarehouseTypes.REDSHIFT
string
ChartType.PIE
string
SnowflakeAuthenticationType
string
ApiGetTagsResponse
object
2 properties
2 required
Pick_AiArtifact.Exclude_keyofAiArtifact.chartConfig-or-dashboardConfig__
object
From T, pick a set of properties whose keys are in the union K
14 properties
14 required
ApiUpdateAiAgentMcpServerToolsRequest
object
1 property
1 required
ApiRenameChartBody
object
4 properties
3 required
KnexPaginatedData__runs-AiAgentEvaluationRunSummary-Array__
object
2 properties
1 required
ApiStartAiMcpOAuthResponse
ApiSuccess_ApiRefreshResults_
object
2 properties
2 required
CreateDuckdbCredentials
ValidationErrorDashboardResponse
Pick_CreateClickhouseCredentials.Exclude_keyofCreateClickhouseCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
9 properties
4 required
Record_string.DashboardTileTarget_
object
Construct a type with a set of properties K of type T
UserWarehouseCredentialsProject
object
3 properties
3 required
ApiProjectColorPaletteResponse
object
2 properties
2 required
Record_string.unknown_
object
Construct a type with a set of properties K of type T
CustomGroupBinDimension
object
7 properties
7 required
LineageGraph
DucklakeCatalogType.SQLITE
string
Omit_CreateDuckdbMotherduckCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
SankeyNodeLayout
string
How nodes are laid out: - multi-step: depth-unrolled journeys (default) - merged: one node per label, journeys preserved (acyclic flows only) - direct: two-col…
Pick_AiArtifact.artifactUuid-or-versionNumber-or-versionUuid-or-title-or-description-or-artifactType_
object
From T, pick a set of properties whose keys are in the union K
6 properties
6 required
ApiProjectResponse
object
2 properties
2 required
DashboardLoomTileProperties
object
2 properties
2 required
ApiSuccess_AiMcpGithubAvailability_
object
2 properties
2 required
Pick_DashboardChartTileProperties-at-properties.title-or-hideTitle-or-chartName_
object
From T, pick a set of properties whose keys are in the union K
3 properties
AiAgentEvaluation
object
7 properties
7 required
UpstreamFieldChangeKind
string
Field-level diff between a preview project and the project it was copied from (upstreamProjectUuid), computed in SQL over the catalogsearch index. Detects adde…
ApiRenameDashboardResponse
object
2 properties
2 required
DbtAzureDevOpsProjectConfig
object
10 properties
7 required
XAxis
ChartType.CUSTOM
string
ApiDeployExploresResults
object
2 properties
2 required
ChartType.MAP
string
ModelRequiredFilterRule
Omit_CreateRedshiftCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
ApiVerifiedContentListResponse
object
2 properties
2 required
ApiSuccess_Pick_AiAgentEvaluation.evalUuid__
object
2 properties
2 required
ColorPaletteSource
Where a resolved colour palette came from. The config and default cases carry no entity reference; the rest expose the UUID and human-readable name of the enti…
PreAggregateMissReason.GRANULARITY_TOO_FINE
string
AiPromptTokenUsage
object
1 property
1 required
ApiDownloadActivity
object
2 properties
2 required
CartesianChartConfig
object
2 properties
1 required
CompiledExploreJoin
DbTagUpdate
GaugeChart
object
9 properties
DashboardTabAsCode
object
4 properties
3 required
ConditionalFormattingMinMax_number-or-auto_
object
2 properties
2 required
GaugeChartConfig
object
2 properties
1 required
ColumnProperties
object
6 properties
MapChartLocation
string
CalculateSubtotalsFromQuery
Pick_CreateDuckdbMotherduckCredentials.Exclude_keyofCreateDuckdbMotherduckCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
8 properties
4 required
Partial_SummaryExtraFields_
object
Make all properties in T optional
3 properties
TableChart
object
12 properties
AiMcpGithubAvailability
object
2 properties
2 required
Omit_CreateBigqueryCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
ContentAsCodeType.DASHBOARD
string
StackType
string
Omit_CreateDuckdbDucklakeCredentials.catalog-or-dataPath_
Construct a type with the properties of T except for those in type K.
Partial_CompleteEChartsConfig_
object
Make all properties in T optional
10 properties
ApiAiAgentResponse
object
2 properties
2 required
CartesianChartDisplay
object
5 properties
ApiSuccess_AiAgentThreadPullRequest-or-null_
object
2 properties
2 required
AiMcpServer
object
14 properties
14 required
UpstreamFieldDiff
object
7 properties
7 required
PieChartLegendPosition
string
ApiValidationDismissResponse
object
1 property
1 required
DimensionType
string
CreateDashboardSqlChartTile
CreateDucklakeCatalogPostgres
object
6 properties
6 required
UpdatedByUser
object
3 properties
3 required
AndFilterGroupInput
object
2 properties
1 required
ApiChartAsCodeListResponse
object
2 properties
2 required
ApiGetUserAgentPreferencesResponse
DucklakeDataPathLocal
Record_string.CompiledMetric_
object
Construct a type with a set of properties K of type T
AiThreadCompaction
object
5 properties
5 required
VizAggregationOptions
string
ApiAiAgentThreadResponse
object
2 properties
2 required
FrameClause
object
3 properties
2 required
ValidationResponse
EchartsLegend
object
12 properties
ProjectMemberProfile
object
7 properties
6 required
ApiAppendInstructionResponse
VizBaseConfig
object
2 properties
2 required
ContentType
string
ProjectCompileLog
object
12 properties
12 required
AiMcpServerConnectionStatus
string
DataTimezonePreviewRequest
CreateDucklakeDataPathS3
object
8 properties
2 required
FieldType
string
ValidationErrorChartResponse
FilterRule_FilterOperator.DashboardFieldTarget.AnyType.AnyType_
object
8 properties
3 required
Omit_DashboardAsCode.tiles-or-description_
Construct a type with the properties of T except for those in type K.
CreateDashboardWithCharts
object
4 properties
3 required
PreAggregateMissReason.DIMENSION_NOT_IN_PRE_AGGREGATE
string
ApiDashboardValidationResponse
ApiAppendInstructionRequest
object
1 property
1 required
CreateDucklakeCatalog
DbtProjectType.AZURE_DEVOPS
string
Pick_CreateDucklakeDataPathGcs.Exclude_keyofCreateDucklakeDataPathGcs.hmacKeyId-or-hmacSecret__
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
MapChartType
string
Pick_Dashboard.uuid-or-name-or-description-or-spaceUuid_
object
From T, pick a set of properties whose keys are in the union K
4 properties
3 required
BaseFilterRule_FilterOperator.number-or-string_
object
3 properties
2 required
MarkLineData
object
9 properties
1 required
AiVizMetadata
object
2 properties
2 required
ApiAiAgentThreadGenerateResponse
object
2 properties
2 required
VizPieChartConfig
Compact
string
AiAgentUserPreferences
object
1 property
1 required
DbtProjectType.NONE
string
Pick_ExploreJoin.table-or-sqlOn-or-type-or-hidden-or-always-or-relationship_
object
From T, pick a set of properties whose keys are in the union K
6 properties
2 required
Omit_CreateDucklakeDataPathS3.accessKeyId-or-secretAccessKey_
Construct a type with the properties of T except for those in type K.
TableCalculationTemplateType.RUNNING_TOTAL
string
Omit_FilterRule.id_
Construct a type with the properties of T except for those in type K.
SpaceAsCode
object
3 properties
3 required
WarehouseTypes.SNOWFLAKE
string
Pick_Dashboard.Exclude_keyofDashboard.inheritsFromOrgOrProject-or-access__
object
From T, pick a set of properties whose keys are in the union K
25 properties
19 required
BinType.CUSTOM_GROUP
string
FieldCompilationError
object
Error information stored on a field when compilation fails but partial compilation mode is enabled.
1 property
1 required
AssessmentType
string
TableCalculationBase
object
5 properties
2 required
TableChartConfig
object
2 properties
1 required
DashboardTileTypes.DATA_APP
string
DashboardMarkdownTileAsCode
DbtManifestProjectConfig
object
3 properties
3 required
TableCalculationTemplateType.PERCENT_OF_COLUMN_TOTAL
string
ComparisonFormatTypes
string
CreateClickhouseCredentials
object
11 properties
6 required
UpdateQueryTimezoneSettings
object
2 properties
Omit_AiArtifact.chartConfig-or-dashboardConfig_
Construct a type with the properties of T except for those in type K.
ApiAiAgentSummaryResponse
object
2 properties
2 required
DashboardAsCode
PreAggregateMissReason.CUSTOM_METRIC_PRESENT
string
AiAgentMcpServerTool
CartesianSeriesType.LINE
string
DashboardHeadingTileProperties
object
2 properties
2 required
DownloadAuditEntry
object
8 properties
8 required
Pick_CreatePostgresCredentials.Exclude_keyofCreatePostgresCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
22 properties
5 required
KnexPaginateArgs
object
2 properties
2 required
CreateDuckdbMotherduckCredentials
object
9 properties
5 required
PreAggregateMissReason.FILTER_DIMENSION_NOT_IN_PRE_AGGREGATE
string
JoinModelRequiredFilterRule
object
8 properties
3 required
DashboardBasicDetails
CustomFormatType
string
CalculateTotalFromQuery
object
4 properties
2 required
DashboardTileTypes.SAVED_CHART
string
ApiFormulaValidationResults
ApiAiMcpServerToolListResponse
ApiExploresResults
array
ApiProjectCompileLogsResponse
object
2 properties
2 required
AiAgentThreadPullRequest
object
Overview of the writeback PR a thread is associated with — either the PR the agent opened in this thread, or the PR a remediation verification thread is verify…
10 properties
10 required
ApiGetProjectGroupAccesses
object
2 properties
2 required
PreAggregateMissReason.TABLE_CALCULATION_PRESENT
string
ProjectDefaults
object
Project-wide default settings that can be overridden at explore or field level
1 property
ApiSuccess_ApiTableGroupsResults_
object
2 properties
2 required
CustomSqlDimension
object
6 properties
6 required
AndFilterGroup
object
2 properties
2 required
DashboardChartTileAsCode
Pick_ExploreError.SummaryExploreErrorFields_
object
From T, pick a set of properties whose keys are in the union K
8 properties
3 required
CompiledMetric
WeekDay
number
UserAttributeValueMap
CustomDimensionType.SQL
string
AiModelOption
object
6 properties
6 required
DashboardConfig
object
6 properties
1 required
ApiAiAgentMcpServerToolListResponse
ConditionalFormattingWithFilterOperator
CreateChartInSpace
DateZoom
object
2 properties
Pick_SqlChart.name-or-description-or-slug-or-sql-or-limit-or-config-or-chartKind_
object
From T, pick a set of properties whose keys are in the union K
7 properties
7 required
ContentAsCodeType.CHART
string
ApiTableGroupsResults
Pick_AiMcpServer.uuid-or-name-or-iconUrl_
object
From T, pick a set of properties whose keys are in the union K
3 properties
3 required
DucklakeDataPathGcs
ChartSummary
DateGranularity
string
ApiExecuteAsyncQueryResultsCommon
object
5 properties
5 required
Pick_CreateDucklakeDataPathS3.Exclude_keyofCreateDucklakeDataPathS3.accessKeyId-or-secretAccessKey__
object
From T, pick a set of properties whose keys are in the union K
6 properties
2 required
AgentSuggestionNavigateChip
object
3 properties
3 required
Record_string.MapFieldConfig_
object
Construct a type with a set of properties K of type T
PreAggregateCheckResult
CreateDashboardMarkdownTile
DbtModelJoinType
string
Pick_CreateDuckdbCredentials.type_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
PreAggregateMissReason.NO_PRE_AGGREGATES_DEFINED
string
ApiCreateDashboardResponse
object
2 properties
2 required
DuckdbDucklakeCredentials
CreateProjectMember
object
3 properties
3 required
CustomVis
object
1 property
Omit_CreateDucklakeDataPathAzure.connectionString-or-accountKey_
Construct a type with the properties of T except for those in type K.
DbtLocalProjectConfig
object
6 properties
1 required
ApiAiAgentThreadGenerateTitleResponse
object
2 properties
2 required
WarehouseTypes.BIGQUERY
string
AgentSuggestionPromptChip
object
4 properties
4 required
ItemsMap
ApiChartSummaryListResponse
object
2 properties
2 required
OrFilterGroup
object
2 properties
2 required
AiAgentToolCall
UserWithCount
object
4 properties
3 required
PreAggregateMissReason.NON_ADDITIVE_METRIC
string
DbtCloudIDEProjectConfig
object
5 properties
3 required
Omit_CreateDucklakeCatalogPostgres.user-or-password_
Construct a type with the properties of T except for those in type K.
ApiSuccess_ProjectDefaults-or-undefined_
object
2 properties
1 required
BigqueryAuthenticationType
string
DashboardLoomTile
Pick_ValidationResponseBase.Exclude_keyofValidationResponseBase.name__
object
From T, pick a set of properties whose keys are in the union K
8 properties
6 required
VizColumnConfig
object
8 properties
4 required
ApiSqlChartAsCodeUpsertResponse
object
2 properties
2 required
ApiChartValidationResponse
TableCalculationType
string
WarehouseTypes.ATHENA
string
SpaceSummaryBase
DashboardTileAsCode
RedshiftCredentials
ApiAiAgentThreadShareResponse
ApiJobScheduledResponse
object
2 properties
2 required
PartialObjectDeep__dashboard_58___91_x-string_93__58__description_63_-string-or-undefined--name_63_-string-or-undefined--tiles_63__58__40__type-DashboardTileTypes.SAVED_CHART-or-DashboardTileTypes.SQL_CHART--properties_58__title-string--chartName-string__-or-_type-DashboardTileTypes.MARKDOWN--properties_58__content-string--title-string__-or-_type-DashboardTileTypes.LOOM--properties_58__title-string__-or-_type-DashboardTileTypes.HEADING--properties_58__text-string__-or-_type-DashboardTileTypes.DATA_APP--properties_58__title-string___41_-Array-or-undefined___._recurseIntoArrays-true__
object
Same as PartialDeep, but accepts only objects as inputs. Internal helper for PartialDeep.
1 property
ApiSuccess_AiAgentUserPreferences_
object
2 properties
2 required
ApiRevertChangeRequest
object
1 property
1 required
DashboardTab
object
4 properties
3 required
AiAgentProjectThreadSummary
CreateDatabricksCredentials
object
15 properties
4 required
ChartKind.LINE
string
AiPromptContextInput
array
UpdateSchedulerSettings
object
4 properties
ApiDataTimezonePreviewResults
object
4 properties
4 required
ClickhouseCredentials
AiAgentThreadShare
object
11 properties
11 required
ApiSuccess_AiMcpServer-Array_
object
2 properties
2 required
AiAgentThread
ApiAiAgentThreadSummaryListResponse
object
2 properties
2 required
ExploreAnalysisEvaluation
ApiSuccess_KnexPaginatedData_AiAgentProjectThreadSummary-Array__
object
2 properties
2 required
Omit_Pick_SavedChart.name-or-description-or-tableName-or-metricQuery-or-chartConfig-or-pivotConfig-or-slug-or-parameters_.metricQuery_
Construct a type with the properties of T except for those in type K.
SavedChartDAO
ApiSuccess_AiAgentThreadSummary_
object
2 properties
2 required
ApiAiAgentExploreAccessSummaryResponse
DashboardMarkdownTileProperties
object
2 properties
2 required
MapHexbinAggregation
string
ChartType.CARTESIAN
string
Omit_DashboardFilterRule.id_
Construct a type with the properties of T except for those in type K.
GroupType
object
2 properties
1 required
AiEvalRunResultAssessment
object
10 properties
10 required
Pick_SavedChart.updatedAt-or-updatedByUser-or-pinnedListOrder_
object
From T, pick a set of properties whose keys are in the union K
3 properties
2 required
ApiSqlChartAsCodeListResponse
object
2 properties
2 required
DashboardParameters
ApiCloneAiAgentThreadShareResponse
AthenaAuthenticationType
string
PromotedSqlChart
object
8 properties
8 required
Pick_Space.organizationUuid-or-projectUuid-or-uuid-or-name-or-inheritParentPermissions-or-projectMemberAccessRole-or-pinnedListUuid-or-pinnedListOrder-or-slug-or-parentSpaceUuid-or-path_
object
From T, pick a set of properties whose keys are in the union K
11 properties
11 required
DbtVersionOptionLatest
string
DatabricksAuthenticationType
string
JoinModelRequiredFilterTarget
object
2 properties
2 required
BigqueryProject
object
2 properties
2 required
ApiAppendEvaluationRequest
object
1 property
1 required
DashboardTileTypes.HEADING
string
SpaceSummary
VerifiedContentListItem
object
8 properties
8 required
FunnelChartDataInput
string
DashboardTileTypes.SQL_CHART
string
ChartKind
string
SeriesMetadata
object
1 property
1 required
ApiSuccess_AiAgentEvaluationRunSummary_
object
2 properties
2 required
Pick_CreateDuckdbDucklakeCredentials.Exclude_keyofCreateDuckdbDucklakeCredentials.catalog-or-dataPath__
object
From T, pick a set of properties whose keys are in the union K
8 properties
3 required
DbtProjectType.GITLAB
string
ChartKind.TABLE
string
MetricType
string
ContentAsCodeType.SPACE
string
SqlChartAsCode
ApiBigqueryProjects
object
2 properties
2 required
PivotIndexColum
object
2 properties
2 required
AiAgentEvaluationRunResult
object
10 properties
10 required
Pick_CreateSnowflakeCredentials.Exclude_keyofCreateSnowflakeCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
19 properties
5 required
RenameChange
object
2 properties
2 required
Axis
object
7 properties
AiAgentThreadSummary_AiAgentUser_
object
8 properties
8 required
Record_string.GroupType_
object
Construct a type with a set of properties K of type T
FilterRuleInput
Permissive filter types for chart-as-code uploads where id may be omitted. Filter IDs are auto-generated during upsert if absent. After normalization these bec…
Pick_AiAgentEvaluation.evalUuid-or-agentUuid-or-title-or-description-or-createdAt-or-updatedAt_
object
From T, pick a set of properties whose keys are in the union K
6 properties
6 required
TableCalculation
Record_string.LightdashProjectParameter_
object
Construct a type with a set of properties K of type T
AgentSuggestion
SupportedDbtAdapter
string
SankeyChart
object
6 properties
FilterRule
object
8 properties
3 required
ApiPreviewExpirationProjectSettingsResponse
AiAgentEvaluationRun
Pick_CreateDatabricksCredentials.type_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
CompiledProperties
object
7 properties
1 required
PromotedDashboard
Pick_AiAgent.uuid-or-name-or-description-or-integrations-or-tags-or-projectUuid-or-organizationUuid-or-createdAt-or-updatedAt-or-instruction-or-imageUrl-or-groupAccess-or-userAccess-or-spaceAccess-or-enableDataAccess-or-enableSelfImprovement-or-enableContentTools-or-version_
object
From T, pick a set of properties whose keys are in the union K
18 properties
18 required
DashboardBasicDetailsWithTileTypes
PreAggregateMissReason.CUSTOM_DIMENSION_PRESENT
string
ValidationSummary
Field
object
20 properties
8 required
DucklakeDataPathType.S3
string
AiAgentReasoning
object
5 properties
5 required
SpaceQuery
ApiSuccess__authorizationUrl-string__
object
2 properties
2 required
PromotedApp
object
2 properties
2 required
PromotedChart
ApiCreateEvaluationResponse
ConditionalFormattingConfigWithSingleColor
object
5 properties
3 required
ApiCompiledQueryResults
object
4 properties
2 required
KnexPaginatedData_AiAgentVerifiedArtifact-Array_
object
2 properties
1 required
Record_string.ColumnProperties_
object
Construct a type with a set of properties K of type T
GroupValueMatchType
string
Pick_DashboardFilterRule.Exclude_keyofDashboardFilterRule.id__
object
From T, pick a set of properties whose keys are in the union K
11 properties
2 required
KnexPaginatedData_AiAgentProjectThreadSummary-Array_
object
2 properties
1 required
Dashboard
object
27 properties
21 required
ReadinessScoreEvaluation
object
2 properties
2 required
ParameterValue
Pick_CreateTrinoCredentials.Exclude_keyofCreateTrinoCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
10 properties
6 required
ApiAiAgentThreadCreateRequest
object
3 properties
ApiExploreResults
ParametersValuesMap
PreviewExpirationProjectSettings
object
3 properties
3 required
WindowFunctionType
string
ApiAiMcpServerResponse
FunnelChartConfig
object
2 properties
1 required
ValidationErrorTableResponse
ProjectType
string
DucklakeCatalogPostgres
DuckdbConnectionType.DUCKLAKE
string
ChartConfig
DashboardChartTile
Omit_Dashboard.inheritsFromOrgOrProject-or-access_
Construct a type with the properties of T except for those in type K.
Dimension
object
37 properties
8 required
Record_string.string-Array_
object
Construct a type with a set of properties K of type T
AiAgentEvaluationSummary
AiAgentMessage_AiAgentUser_
ConditionalFormattingWithCompareTarget_number-or-string_
ValueLabelPositionOptions
string
Pick_AiAgent.projectUuid-or-integrations-or-tags-or-name-or-description-or-instruction-or-imageUrl-or-groupAccess-or-userAccess-or-spaceAccess-or-enableDataAccess-or-enableSelfImprovement-or-version_
object
From T, pick a set of properties whose keys are in the union K
13 properties
13 required
BinType.FIXED_WIDTH
string
DashboardDataAppTileAsCode
PartialDeep_ChartAsCodeLanguageMap._recurseIntoArrays-true__
Create a type from another type with all keys and nested keys set to optional. Use-cases: - Merging a default settings/config object with another object, the s…
ApiSuccess_PreviewExpirationProjectSettings_
object
2 properties
2 required
AiResultType
string
ChartSourceType
string
DbtProjectType.DBT
string
FilterOperator
string
Project
object
21 properties
16 required
WarehouseCredentials
CustomDimensionType.BIN
string
DuckdbConnectionType.MOTHERDUCK
string
InstructionQualityEvaluation
WarehouseTypes.DUCKDB
string
Record_string.string_
object
Construct a type with a set of properties K of type T
AiAgentMessageAssistant
object
17 properties
16 required
CreateDucklakeDataPathGcs
object
4 properties
2 required
TableBase
object
23 properties
5 required
Format
string
ConditionalFormattingColorApplyTo
string
SshTunnelConfiguration
object
6 properties
CreateDucklakeDataPathLocal
object
2 properties
2 required
CreateSavedChart
ApiConnectGithubMcpServerBody
object
2 properties
2 required
CreateDashboardChartTile
ApiSuccess_AiAgentExploreAccessSummary-Array_
object
2 properties
2 required
PreAggregateMaterializationRole
object
2 properties
2 required
FieldUrl
object
2 properties
2 required
DashboardTileTarget
ApiSuccess_KnexPaginatedData__runs-AiAgentEvaluationRunSummary-Array___
object
2 properties
2 required
PivotConfiguration
object
9 properties
1 required
Metric
object
33 properties
8 required
ApiCreateEvaluationRequest
object
3 properties
2 required
RowLimit
object
3 properties
3 required
Pick_Metric.formatOptions_
object
From T, pick a set of properties whose keys are in the union K
1 property
DashboardTileTypes.LOOM
string
Pick_Explore.Exclude_keyofExplore.unfilteredTables__
object
From T, pick a set of properties whose keys are in the union K
22 properties
7 required
TreemapChartConfig
object
2 properties
1 required
ApiAiAgentVerifiedArtifactsResponse
ApiRenameDashboardBody
object
4 properties
3 required
UpdateMultipleDashboards
Pick_ValidationErrorChartResponse.error-or-errorType-or-fieldName-or-name-or-projectUuid-or-chartUuid-or-source-or-chartName_
object
From T, pick a set of properties whose keys are in the union K
8 properties
4 required
FixedWidthBinDimension
object
7 properties
7 required
CreateDashboardValidation
MapChart
object
26 properties
ApiSuccess_KnexPaginatedData_AiAgentVerifiedArtifact-Array__
object
2 properties
2 required
Pick_Explore.name_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
DbtProjectType.BITBUCKET
string
ApiAiAgentThreadCreateResponse
DimensionOverrides
object
AiArtifactTSOACompat
Pick_DashboardAsCode.Exclude_keyofDashboardAsCode.tiles-or-description__
object
From T, pick a set of properties whose keys are in the union K
13 properties
5 required
RenameType
string
BinType.FIXED_NUMBER
string
ApiAiAgentVerifiedQuestionsResponse
DbtBitBucketProjectConfig
object
10 properties
6 required
ApiSuccess__errors-CreateChartValidation-Array__
object
2 properties
2 required
TableCalculationTemplateType.PERCENT_OF_PREVIOUS_VALUE
string
DashboardTileTypes
string
Pick_Pick_SavedChart.name-or-description-or-tableName-or-metricQuery-or-chartConfig-or-pivotConfig-or-slug-or-parameters_.Exclude_keyofPick_SavedChart.name-or-description-or-tableName-or-metricQuery-or-chartConfig-or-pivotConfig-or-slug-or-parameters_.metricQuery__
object
From T, pick a set of properties whose keys are in the union K
7 properties
4 required
ApiCreateTagResponse
object
2 properties
2 required
PreAggregateMissReason.EXPLORE_RESOLUTION_ERROR
string
ApiSuccess_AiAgentEvaluationSummary-Array_
object
2 properties
2 required
SpaceAccess
object
6 properties
3 required
UserActivity
object
14 properties
14 required
ApiSuccess_undefined_
object
2 properties
1 required
FormulaTableCalculation
LightdashProjectParameter
object
8 properties
1 required
DashboardSqlChartTile
PreAggregateMissReason.METRIC_NOT_IN_PRE_AGGREGATE
string
Pick_DashboardSqlChartTileProperties-at-properties.title-or-hideTitle-or-chartName_
object
From T, pick a set of properties whose keys are in the union K
3 properties
1 required
SslConfiguration
object
7 properties
ApiAiAgentSqlApprovalResponse
UpdateDefaultUserSpaces
object
1 property
1 required
FrameType
string
FilterGroupItemInput
Pick_SqlChartAsCode.Exclude_keyofSqlChartAsCode.config-or-description__
object
From T, pick a set of properties whose keys are in the union K
10 properties
7 required
FieldId
string
SortByDirection
string
CreateChartInDashboard
BigNumber
object
11 properties
ApiUpdateUserAgentPreferencesResponse
DefaultTimeDimension
object
2 properties
2 required
AiMcpCredentialScope
string
CreateDashboardLoomTile
SummaryExplore
DbtGithubProjectConfig
object
11 properties
5 required
SummaryExtraFields
object
3 properties
2 required
FieldTarget
object
1 property
1 required
CreateDucklakeDataPathAzure
object
5 properties
2 required
Omit_CreateSnowflakeCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
DbtProjectConfig
Record_string.string-or-string-Array_
object
Construct a type with a set of properties K of type T
WarehouseTypes.DATABRICKS
string
PreAggregateMissReason.USER_BYPASS
string
ApiUpdateUserAgentPreferences
PreAggregateMatchMiss
Partial_Pick_DbTag.name-or-color__
object
Make all properties in T optional
2 properties
DataTimezonePreviewNaive
object
4 properties
4 required
PartialObjectDeep___91_x-string_93__58__description_63_-string-or-undefined--name_63_-string-or-undefined--chartConfig_63__58__type-ChartType.CARTESIAN--config_63__58__eChartsConfig_58__series_63__58__name_63_-string-or-undefined--markLine_63__58__data_58__name_63_-string-or-undefined_-Array_-or-undefined_-Array-or-undefined--xAxis_63__58__name_63_-string-or-undefined_-Array-or-undefined--yAxis_63__58__name_63_-string-or-undefined_-Array-or-undefined__-or-undefined_-or-_type-ChartType.PIE--config_63__58__groupLabelOverrides_63_-Record_string.string_-or-undefined_-or-undefined_-or-_type-ChartType.FUNNEL--config_63__58__labelOverrides_63_-Record_string.string_-or-undefined_-or-undefined_-or-_type-ChartType.BIG_NUMBER--config_63__58__label_63_-string-or-undefined--comparisonLabel_63_-string-or-undefined--comparisonField_63_-string-or-undefined_-or-undefined_-or-_type-ChartType.TABLE--config_63__58__columns_63_-Record_string._name-string__-or-undefined_-or-undefined_-or-_type-ChartType.CUSTOM--config_63__58__spec_63_-Record_string.unknown_-or-undefined_-or-undefined_-or-undefined__._recurseIntoArrays-true__
object
Same as PartialDeep, but accepts only objects as inputs. Internal helper for PartialDeep.
PromotionChanges
object
5 properties
3 required
DashboardMarkdownTile
CompactOrAlias
CustomVisConfig
object
2 properties
1 required
BinGroup
object
2 properties
2 required
Record_string._type-DimensionType__
object
Construct a type with a set of properties K of type T
ApiUserActivity
object
2 properties
2 required
Omit_CreateClickhouseCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
AiAgent
CreateAthenaCredentials
object
17 properties
5 required
ApiAiAgentProjectThreadSummaryListResponse
ApiSetExploresResponse
object
2 properties
2 required
CreateEvaluationPrompt
Represents a prompt for evaluation that can be either: - An object with a prompt string for new prompts - An object referencing an existing prompt and thread b…
ContentAsCodeType.SQL_CHART
string
BigqueryDataset
object
3 properties
2 required
DashboardTileTypes.MARKDOWN
string
TableCalculationTemplateType.PERCENT_CHANGE_FROM_PREVIOUS
string
DashboardHeadingTileAsCode
TooltipSortBy
string
Record_string.SeriesMetadata_
object
Construct a type with a set of properties K of type T
Pick_CreateDucklakeDataPathAzure.Exclude_keyofCreateDucklakeDataPathAzure.connectionString-or-accountKey__
object
From T, pick a set of properties whose keys are in the union K
3 properties
2 required
SortField
object
4 properties
2 required
NumberSeparator
string
CustomBinDimension
CreateSnowflakeCredentials
object
25 properties
6 required
DbtGitlabProjectConfig
object
9 properties
5 required
CreateChartBase
AiAgentMessageAssistantArtifact
VizTableDisplay
object
DbtProjectType.DBT_CLOUD_IDE
string
Partial_Pick_AiAgent.projectUuid-or-integrations-or-tags-or-name-or-description-or-instruction-or-imageUrl-or-groupAccess-or-userAccess-or-spaceAccess-or-enableDataAccess-or-enableSelfImprovement-or-enableContentTools-or-version__
object
Make all properties in T optional
14 properties
ApiAiAgentEvaluationRunResultsResponse
Pick_AiAgentMcpServerTool.toolName-or-enabled_
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
SankeyChartConfig
object
2 properties
1 required
DbtVersionOption
AiAgentMcpToolName
string
ApiAiAgentArtifactResponseTSOACompat
CreateDashboard
object
11 properties
3 required
ApiAiAgentThreadStreamRequest
object
2 properties
DashboardFilters
object
3 properties
3 required
AxisSide
number
AiAgentSummary
DashboardTileBase
ApiGetDashboardsResponse
object
2 properties
2 required
CreateDucklakeCatalogDuckdb
object
2 properties
2 required
Pick_CreateBigqueryCredentials.Exclude_keyofCreateBigqueryCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
15 properties
3 required
XAxisSortType
string
ApiUpstreamDiffResponse
object
2 properties
2 required
PreAggregateMissReason.PRE_AGGREGATE_FILTER_NOT_SATISFIED
string
DataTimezonePreviewAware
object
2 properties
2 required
ApiAiAgentEvaluationResponse
DashboardDataAppTileProperties
object
2 properties
2 required
Omit_CreateTrinoCredentials.SensitiveCredentialsFieldNames_
Construct a type with the properties of T except for those in type K.
ViewStatistics
object
2 properties
2 required
BinType.CUSTOM_RANGE
string
DuckdbMotherduckCredentials
Pick_CreateBigqueryCredentials.type_
object
From T, pick a set of properties whose keys are in the union K
1 property
1 required
ApiAiAgentThreadMessageVizQueryResponse
object
2 properties
2 required
VizSortBy
object
4 properties
2 required
ActivityViews
object
3 properties
3 required
PartialObjectDeep__chart_58___91_x-string_93__58__description_63_-string-or-undefined--name_63_-string-or-undefined--chartConfig_63__58__type-ChartType.CARTESIAN--config_63__58__eChartsConfig_58__series_63__58__name_63_-string-or-undefined--markLine_63__58__data_58__name_63_-string-or-undefined_-Array_-or-undefined_-Array-or-undefined--xAxis_63__58__name_63_-string-or-undefined_-Array-or-undefined--yAxis_63__58__name_63_-string-or-undefined_-Array-or-undefined__-or-undefined_-or-_type-ChartType.PIE--config_63__58__groupLabelOverrides_63_-Record_string.string_-or-undefined_-or-undefined_-or-_type-ChartType.FUNNEL--config_63__58__labelOverrides_63_-Record_string.string_-or-undefined_-or-undefined_-or-_type-ChartType.BIG_NUMBER--config_63__58__label_63_-string-or-undefined--comparisonLabel_63_-string-or-undefined--comparisonField_63_-string-or-undefined_-or-undefined_-or-_type-ChartType.TABLE--config_63__58__columns_63_-Record_string._name-string__-or-undefined_-or-undefined_-or-_type-ChartType.CUSTOM--config_63__58__spec_63_-Record_string.unknown_-or-undefined_-or-undefined_-or-undefined___._recurseIntoArrays-true__
object
Same as PartialDeep, but accepts only objects as inputs. Internal helper for PartialDeep.
1 property
AiPromptContext
array
InlineErrorType
string
CreatePostgresCredentials
ApiChartAsCodeUpsertResponse
object
2 properties
2 required
Pick_SavedChart.uuid-or-name-or-description-or-spaceName-or-spaceUuid-or-projectUuid-or-organizationUuid-or-pinnedListUuid-or-dashboardUuid-or-dashboardName-or-slug_
object
From T, pick a set of properties whose keys are in the union K
11 properties
10 required
ApiUpdateEvaluationRequest
object
3 properties
ApiSuccess_ReadinessScore_
object
2 properties
2 required
ApiRenameResponse
object
2 properties
2 required
ApiUserActivityDownloadCsv
object
2 properties
2 required
PromotionAction
string
CreateDuckdbDucklakeCredentials
object
10 properties
5 required
Omit_ValidationResponseBase.name_
Construct a type with the properties of T except for those in type K.
ApiAiAgentSqlApprovalRequest
object
1 property
1 required
Partial_Explore_
object
Make all properties in T optional
23 properties
CustomRangeBinDimension
object
7 properties
7 required
PivotSortAnchor
object
Coordinates of a single pivot column, used to anchor a row sort to that specific column when results are pivoted.
2 properties
2 required
ExploreError
ValidationTarget
string
Record_string.ParameterValue_
object
Construct a type with a set of properties K of type T
TableCalculationTemplateType.RANK_IN_COLUMN
string
ApiProjectCompileLogResponse
object
2 properties
2 required
Omit_SavedChart.inheritsFromOrgOrProject-or-access_
Construct a type with the properties of T except for those in type K.
AiAgentUser
object
2 properties
2 required
ApiUpdateAiAgent
ChartType.TREEMAP
string
ConditionalFormattingWithValues_number-or-string_
DashboardFieldTarget
object
4 properties
2 required
ConditionalFormattingColorRange
object
2 properties
2 required
PieChartConfig
object
2 properties
1 required
WarehouseTypes.CLICKHOUSE
string
CreateChartValidation
AiAgentExploreAccessSummary
object
4 properties
4 required
FunnelChart
object
8 properties
DashboardTileAsCodeBase
object
8 properties
5 required
VizPieChartDisplay
object
1 property
ApiSuccess_AiMcpServer_
object
2 properties
2 required
EchartsGrid
object
7 properties
Omit_MetricQuery.filters_
Construct a type with the properties of T except for those in type K.
ApiCloneThreadResponse
CartesianChart
object
6 properties
2 required
PostgresCredentials
UpdateMetadata
object
1 property
Pick_Pick_Dashboard.name-or-description-or-tabs-or-slug-or-config-or-parameters_.Exclude_keyofPick_Dashboard.name-or-description-or-tabs-or-slug-or-config-or-parameters_.name-or-slug-or-tabs__
object
From T, pick a set of properties whose keys are in the union K
3 properties
BigqueryCredentials
Omit_Pick_Dashboard.name-or-description-or-tabs-or-slug-or-config-or-parameters_.name-or-slug-or-tabs_
Construct a type with the properties of T except for those in type K.
CreateDashboardTileBase
object
7 properties
5 required
Pick_Explore.name-or-label-or-groupLabel-or-groups_
object
From T, pick a set of properties whose keys are in the union K
4 properties
2 required
FunnelChartLabelPosition
string
CompiledTable
DucklakeDataPath
ApiSpaceSummaryListResponse
object
2 properties
2 required
EChartsConfig
MetricFilterRule
object
Filter rule for metrics, targeting fields by reference
8 properties
3 required
MapHexbinValueBasis
string
Pick_CreateAthenaCredentials.Exclude_keyofCreateAthenaCredentials.SensitiveCredentialsFieldNames__
object
From T, pick a set of properties whose keys are in the union K
15 properties
5 required
AiPromptContextItemInput
ContentVerificationInfo
object
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Lightdash 12
Other APIs Lightdash publishes across the network.
Lightdash AiAgents API
Lightdash Bulk action API
Lightdash Catalog API
Lightdash Changesets API
Lightdash Charts API
Lightdash Comments API
Lightdash Content API
Lightdash Custom Roles API
Lightdash Dashboards API
Lightdash Explorer API
Lightdash Exploring API
Lightdash Exports API
#Project
Where this information came from
This is an independent, third-party profile of Lightdash Projects API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.