Duck Data Platform
Docs API Reference
GitHub repository
Docs API Reference

Search

Search API reference

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

Models

Schema: `TabularColumn`

  • Type: object
  • Required fields: name

Properties

Name Type Required Description
name string true -
← Schema: `TableStatistics` Schema: `TagAssignmentSecurableType` →
On this page
  • Schema: `TabularColumn`
  • Properties