API Reference
API Reference
This section is generated from the OpenAPI artifact (api/gen/openapi.yaml by default).
Endpoint Groups
- Assets (20 operations)
- Audit (1 operations)
- Auth (7 operations)
- Catalogs (38 operations)
- Compute (11 operations)
- Dashboards (9 operations)
- Governance (22 operations)
- Health (1 operations)
- Identity (17 operations)
- Integrations (5 operations)
- Lineage (7 operations)
- Models (26 operations)
- Notebooks (31 operations)
- Pipelines (13 operations)
- Products (32 operations)
- Queries (7 operations)
- Resources (4 operations)
- Semantic Layer (21 operations)
- Storage (10 operations)
Schemas
- APIKeyInfo
- Asset
- AssetAutoMaterializePolicy
- AssetBackfillDetails
- AssetCheck
- AssetCheckInput
- AssetCheckList
- AssetCheckResult
- AssetCheckSeverity
- AssetFreshnessBlocker
- AssetFreshnessBlockersResponse
- AssetFreshnessEdge
- AssetFreshnessExplanation
- AssetFreshnessPolicy
- AssetFreshnessReconcileResponse
- AssetFreshnessReconcileTarget
- AssetFreshnessRequirement
- AssetFreshnessRequirementsResponse
- AssetFreshnessStatus
- AssetGraph
- AssetMaterialization
- AssetMaterializationPolicy
- AssetPartition
- AssetRun
- AssetRunStatus
- AssetTriggerResponse
- AssetTriggerType
- AuditDecisionStatus
- AuditEntry
- AuthLoginResponse
- AuthPrincipalSummary
- BackfillRequest
- BackfillSlice
- BootstrapCompleteRequest
- BootstrapTokenRequest
- BootstrapTokenResponse
- CancelQueryResponse
- CatalogHistoryEntry
- CatalogHistoryResponse
- CatalogInfo
- CatalogRegistration
- CatalogRegistrationList
- CatalogStatus
- CatalogVersionSummary
- Cell
- CellCellType
- CellExecutionResult
- CellList
- CellRole
- CleanupAPIKeysResponse
- ColumnDetail
- ColumnLineageEdge
- ColumnLineageEdgeTransformType
- ColumnMask
- ColumnMaskBinding
- ColumnMaskBindingRequest
- CommitIngestionRequest
- ComputeAssignment
- ComputeAssignmentPrincipalType
- ComputeEndpoint
- ComputeEndpointHealth
- ComputeEndpointSize
- ComputeEndpointStatus
- ComputeEndpointType
- ComputeRoutingDefaults
- CreateAPIKeyRequest
- CreateAPIKeyResponse
- CreateAssetBackfillRequest
- CreateAssetBackfillResponse
- CreateAssetRequest
- CreateCatalogRequest
- CreateCellRequest
- CreateColumnMaskRequest
- CreateColumnRequest
- CreateComputeAssignmentRequest
- CreateComputeEndpointRequest
- CreateDashboardRequest
- CreateDashboardWidgetRequest
- CreateDataProductRequest
- CreateDataProductVersionRequest
- CreateExternalLocationRequest
- CreateFolderRequest
- CreateGitRepoRequest
- CreateGrantRequest
- CreateGroupMemberRequest
- CreateGroupRequest
- CreateMacroRequest
- CreateModelRequest
- CreateModelTestRequest
- CreateNotebookRequest
- CreatePipelineJobRequest
- CreatePipelineRequest
- CreatePrincipalRequest
- CreateProductDependencyRequest
- CreateProductDomainRequest
- CreateProductSubscriptionRequest
- CreateProductTeamRequest
- CreateRowFilterRequest
- CreateSavedResourceRequest
- CreateSchemaRequest
- CreateSemanticMetricRequest
- CreateSemanticMetricRequestCertificationState
- CreateSemanticModelRequest
- CreateSemanticPreAggregationRequest
- CreateSemanticRelationshipRequest
- CreateStorageCredentialRequest
- CreateTableRequest
- CreateTagAssignmentRequest
- CreateTagRequest
- CreateViewRequest
- CreateVolumeRequest
- Dashboard
- DashboardDetail
- DashboardNotebookCellSource
- DashboardNotebookCellSourceUpdate
- DashboardSQLQuerySource
- DashboardSQLQuerySourceUpdate
- DashboardSemanticQuerySource
- DashboardSemanticQuerySourceUpdate
- DashboardWidget
- DashboardWidgetLayout
- DashboardWidgetLayoutUpdate
- DashboardWidgetSource
- DashboardWidgetSourceKind
- DashboardWidgetSourceUpdate
- DataProduct
- DataProductDetail
- DataProductListItem
- DataProductStatus
- DataProductVersion
- DataProductVersionDetail
- DataProductVersionList
- DeprecateProductVersionRequest
- DuplicateNotebookRequest
- Error
- ExploreItem
- ExternalLocation
- Folder
- FolderShare
- FreshnessPolicy
- FreshnessStatus
- GitRepo
- GitSyncResult
- Group
- GroupMember
- HealthResponse
- IngestionOptions
- IngestionResult
- LineageEdge
- LineageNode
- LoadExternalRequest
- LocalLoginRequest
- Macro
- MacroImpactList
- MacroImpactModel
- MacroRevision
- MacroRevisionDiff
- MacroRevisionList
- MacroStatus
- MacroType
- MacroVisibility
- ManifestColumn
- ManifestResponse
- MetastoreSummary
- MetastoreType
- MetricFreshnessStatus
- MetricQueryExplainResponse
- MetricQueryJoinStep
- MetricQueryPlan
- MetricQueryRequest
- MetricQueryRunResponse
- Model
- ModelConfig
- ModelConfigOnSchemaChange
- ModelContract
- ModelContractColumn
- ModelDAG
- ModelDAGNode
- ModelDAGTier
- ModelMaterialization
- ModelRun
- ModelRunCompileDiagnostics
- ModelRunStep
- ModelRunStepList
- ModelTest
- ModelTestConfig
- ModelTestList
- ModelTestResult
- ModelTestResultList
- ModelTestResultStatus
- ModelTestTestType
- MoveFolderRequest
- MoveNotebookRequest
- Notebook
- NotebookCellTestConfig
- NotebookContext
- NotebookDetail
- NotebookJob
- NotebookJobState
- NotebookPublishModel
- NotebookSession
- NotebookSessionState
- NotebookShare
- NotebookShareRole
- NotebookTestSeverity
- OIDCProviderRequest
- OIDCProviderResponse
- OrphanResource
- PaginatedAPIKeys
- PaginatedAssetCheckResults
- PaginatedAssetMaterializations
- PaginatedAssetPartitions
- PaginatedAssetRuns
- PaginatedAssets
- PaginatedAuditLogs
- PaginatedBackfillRequests
- PaginatedColumnDetails
- PaginatedColumnLineageEdges
- PaginatedColumnMaskBindings
- PaginatedColumnMasks
- PaginatedComputeAssignments
- PaginatedComputeEndpoints
- PaginatedDashboards
- PaginatedDataProducts
- PaginatedExploreItems
- PaginatedExternalLocations
- PaginatedFolders
- PaginatedGitRepos
- PaginatedGrants
- PaginatedGroupMembers
- PaginatedGroups
- PaginatedLineageEdges
- PaginatedMacros
- PaginatedModelRuns
- PaginatedModels
- PaginatedNotebookJobs
- PaginatedNotebooks
- PaginatedPipelineRuns
- PaginatedPipelines
- PaginatedPrincipals
- PaginatedProductDomains
- PaginatedProductTeams
- PaginatedQueryHistoryEntries
- PaginatedRecentResources
- PaginatedRowFilterBindings
- PaginatedRowFilters
- PaginatedSavedResources
- PaginatedSchemaDetails
- PaginatedSearchResults
- PaginatedSemanticModels
- PaginatedSemanticRelationships
- PaginatedStorageCredentials
- PaginatedTableDetails
- PaginatedTagAssignments
- PaginatedTags
- PaginatedViewDetails
- PaginatedVolumes
- Pipeline
- PipelineJob
- PipelineJobJobType
- PipelineJobList
- PipelineJobRun
- PipelineJobRunList
- PipelineJobRunStatus
- PipelineRun
- PipelineRunStatus
- PipelineRunTriggerType
- Principal
- PrincipalType
- PrivilegeGrant
- ProductAdoptionSummary
- ProductContract
- ProductDependencyList
- ProductDomain
- ProductEvent
- ProductEventList
- ProductOutput
- ProductOutputList
- ProductPortfolioGroup
- ProductPortfolioReport
- ProductSLO
- ProductScorecard
- ProductScorecardList
- ProductSemanticEntrypoint
- ProductSemanticEntrypointList
- ProductSubscription
- ProductSubscriptionList
- ProductTeam
- PromoteNotebookRequest
- PurgeLineageRequest
- PurgeLineageResponse
- QueryHistoryEntry
- QueryJob
- QueryJobStatus
- QueryRequest
- QueryResult
- RecentResource
- ReorderCellsRequest
- ResolvedDashboardDetail
- ResolvedDashboardWidget
- RevokeWebSessionsRequest
- RowFilter
- RowFilterBinding
- RowFilterBindingRequest
- RunAllResult
- SavedResource
- SchemaDetail
- SearchResult
- SemanticMetric
- SemanticMetricExpressionMode
- SemanticMetricList
- SemanticMetricMetricType
- SemanticModel
- SemanticPreAggregation
- SemanticPreAggregationList
- SemanticRelationship
- SemanticRelationshipList
- SemanticRelationshipRelationshipType
- SetDefaultCatalogRequest
- ShareFolderRequest
- ShareNotebookRequest
- SourceFreshnessStatus
- StorageCredential
- StorageCredentialType
- StorageType
- SubmitQueryRequest
- SubmitQueryResponse
- TableDetail
- TableStatistics
- TabularColumn
- Tag
- TagAssignment
- TagAssignmentSecurableType
- TriggerAssetMaterializationRequest
- TriggerModelRunRequest
- TriggerPipelineRunRequest
- URLStyle
- UpdateAssetRequest
- UpdateCatalogRegistrationRequest
- UpdateCellRequest
- UpdateColumnRequest
- UpdateComputeEndpointRequest
- UpdateDashboardRequest
- UpdateDashboardWidgetRequest
- UpdateDataProductRequest
- UpdateExternalLocationRequest
- UpdateFolderRequest
- UpdateGroupRequest
- UpdateMacroRequest
- UpdateModelRequest
- UpdateNotebookRequest
- UpdatePipelineRequest
- UpdatePrincipalAdminRequest
- UpdateProductDomainRequest
- UpdateProductTeamRequest
- UpdateSchemaRequest
- UpdateSemanticMetricRequest
- UpdateSemanticModelRequest
- UpdateSemanticPreAggregationRequest
- UpdateSemanticRelationshipRequest
- UpdateStorageCredentialRequest
- UpdateTableRequest
- UpdateViewRequest
- UpdateVolumeRequest
- UploadUrlRequest
- UploadUrlResponse
- VersionedObjectSummary
- ViewDetail
- VisualChartType
- VisualEncodings
- VisualEncodingsUpdate
- VisualFieldBinding
- VisualFieldBindingUpdate
- VisualOutputKind
- VisualSpec
- VisualSpecUpdate
- VolumeDetail
- WebSessionStatsResponse