Queries

aggregateAcrossEntities

Type: AggregateResults

Aggregate across DataHub entities

Arguments

Name	Description
input AggregateAcrossEntitiesInput!

appConfig

Type: AppConfig

Fetch configurations Used by DataHub UI

assertion

Type: Assertion

Fetch an Assertion by primary key (urn)

Arguments

Name	Description
urn String!

autoComplete

Type: AutoCompleteResults

Autocomplete a search query against a specific DataHub Entity Type

Arguments

Name	Description
input AutoCompleteInput!

autoCompleteForMultiple

Type: AutoCompleteMultipleResults

Autocomplete a search query against a specific set of DataHub Entity Types

Arguments

Name	Description
input AutoCompleteMultipleInput!

batchGetStepStates

Type: BatchGetStepStatesResult!

Batch fetch the state for a set of steps.

Arguments

Name	Description
input BatchGetStepStatesInput!

browse

Type: BrowseResults

Hierarchically browse a specific type of DataHub Entity by path Used by explore in the UI

Arguments

Name	Description
input BrowseInput!

browsePaths

Type: [BrowsePath!]

Retrieve the browse paths corresponding to an entity

Arguments

Name	Description
input BrowsePathsInput!

browseV2

Type: BrowseResultsV2

Browse for different entities by getting organizational groups and their aggregated counts + content. Uses browsePathsV2 aspect and replaces our old browse endpoint.

Arguments

Name	Description
input BrowseV2Input!

chart

Type: Chart

Fetch a Chart by primary key (urn)

Arguments

Name	Description
urn String!

container

Type: Container

Fetch an Entity Container by primary key (urn)

Arguments

Name	Description
urn String!

corpGroup

Type: CorpGroup

Fetch a CorpGroup, representing a DataHub platform group by primary key (urn)

Arguments

Name	Description
urn String!

corpUser

Type: CorpUser

Fetch a CorpUser, representing a DataHub platform user, by primary key (urn)

Arguments

Name	Description
urn String!

dashboard

Type: Dashboard

Fetch a Dashboard by primary key (urn)

Arguments

Name	Description
urn String!

dataFlow

Type: DataFlow

Fetch a Data Flow (or Data Pipeline) by primary key (urn)

Arguments

Name	Description
urn String!

dataJob

Type: DataJob

Fetch a Data Job (or Data Task) by primary key (urn)

Arguments

Name	Description
urn String!

dataPlatform

Type: DataPlatform

Fetch a Data Platform by primary key (urn)

Arguments

Name	Description
urn String!

dataProduct

Type: DataProduct

Fetch a DataProduct by primary key (urn)

Arguments

Name	Description
urn String!

dataset

Type: Dataset

Fetch a Dataset by primary key (urn)

Arguments

Name	Description
urn String!

domain

Type: Domain

Fetch a Domain by primary key (urn)

Arguments

Name	Description
urn String!

entities

Type: [Entity]

Gets entities based on their urns

Arguments

Name	Description
urns [String!]!

entity

Type: Entity

Gets an entity based on its urn

Arguments

Name	Description
urn String!

entityExists

Type: Boolean

Get whether or not not an entity exists

Arguments

Name	Description
urn String!

executionRequest

Type: ExecutionRequest

Get an execution request urn: The primary key associated with the execution request.

Arguments

Name	Description
urn String!

getAccessToken

Type: AccessToken

Generates an access token for DataHub APIs for a particular user & of a particular type Deprecated, use createAccessToken instead

Arguments

Name	Description
input GetAccessTokenInput!

getAnalyticsCharts

Type: [AnalyticsChartGroup!]!

Retrieves a set of server driven Analytics Charts to render in the UI

getEntityCounts

Type: EntityCountResults

Fetches the number of entities ingested by type

Arguments

Name	Description
input EntityCountInput

getGrantedPrivileges

Type: Privileges

Get all granted privileges for the given actor and resource

Arguments

Name	Description
input GetGrantedPrivilegesInput!

getHighlights

Type: [Highlight!]!

Retrieves a set of server driven Analytics Highlight Cards to render in the UI

getInviteToken

Type: InviteToken

Get invite token

Arguments

Name	Description
input GetInviteTokenInput!

getMetadataAnalyticsCharts

Type: [AnalyticsChartGroup!]!

Retrieves a set of charts regarding the ingested metadata

Arguments

Name	Description
input MetadataAnalyticsInput!

getQuickFilters

Type: GetQuickFiltersResult

Get quick filters to display in auto-complete

Arguments

Name	Description
input GetQuickFiltersInput!

getRootGlossaryNodes

Type: GetRootGlossaryNodesResult

Get all GlossaryNodes without a parentNode

Arguments

Name	Description
input GetRootGlossaryEntitiesInput!

getRootGlossaryTerms

Type: GetRootGlossaryTermsResult

Get all GlossaryTerms without a parentNode

Arguments

Name	Description
input GetRootGlossaryEntitiesInput!

getSchemaBlame

Type: GetSchemaBlameResult

Returns the most recent changes made to each column in a dataset at each dataset version.

Arguments

Name	Description
input GetSchemaBlameInput!

getSchemaVersionList

Type: GetSchemaVersionListResult

Returns the list of schema versions for a dataset.

Arguments

Name	Description
input GetSchemaVersionListInput!

getSecretValues

Type: [SecretValue!]

Fetch the values of a set of secrets. The caller must have the MANAGE_SECRETS privilege to use.

Arguments

Name	Description
input GetSecretValuesInput!

globalViewsSettings

Type: GlobalViewsSettings

Fetch the Global Settings related to the Views feature. Requires the 'Manage Global Views' Platform Privilege.

glossaryNode

Type: GlossaryNode

Fetch a Glossary Node by primary key (urn)

Arguments

Name	Description
urn String!

glossaryTerm

Type: GlossaryTerm

Fetch a Glossary Term by primary key (urn)

Arguments

Name	Description
urn String!

ingestionSource

Type: IngestionSource

Fetch a specific ingestion source urn: The primary key associated with the ingestion source.

Arguments

Name	Description
urn String!

isAnalyticsEnabled

Type: Boolean!

Deprecated, use appConfig Query instead Whether the analytics feature is enabled in the UI

join

Type: Join

Fetch a Join by primary key (urn)

Arguments

Name	Description
urn String!

listAccessTokens

Type: ListAccessTokenResult!

List access tokens stored in DataHub.

Arguments

Name	Description
input ListAccessTokenInput!

listDataProductAssets

Type: SearchResults

List Data Product assets for a given urn

Arguments

Name	Description
urn String!
input SearchAcrossEntitiesInput!

listDomains

Type: ListDomainsResult

List all DataHub Domains

Arguments

Name	Description
input ListDomainsInput!

listGlobalViews

Type: ListViewsResult

List Global DataHub Views

Arguments

Name	Description
input ListGlobalViewsInput!

listGroups

Type: ListGroupsResult

List all DataHub Groups

Arguments

Name	Description
input ListGroupsInput!

listIngestionSources

Type: ListIngestionSourcesResult

List all ingestion sources

Arguments

Name	Description
input ListIngestionSourcesInput!

listJoin

Type: ListJoinResult

List all Join

Arguments

Name	Description
input ListJoinInput!

listMyViews

Type: ListViewsResult

List DataHub Views owned by the current user

Arguments

Name	Description
input ListMyViewsInput!

listOwnershipTypes

Type: ListOwnershipTypesResult!

List Custom Ownership Types

Arguments

Name	Description
input ListOwnershipTypesInput!	Input required for listing custom ownership types

listPolicies

Type: ListPoliciesResult

List all DataHub Access Policies

Arguments

Name	Description
input ListPoliciesInput!

listPosts

Type: ListPostsResult

List all Posts

Arguments

Name	Description
input ListPostsInput!

listQueries

Type: ListQueriesResult

List Dataset Queries

Arguments

Name	Description
input ListQueriesInput!	Input required for listing queries

listRecommendations

Type: ListRecommendationsResult

Fetch recommendations for a particular scenario

Arguments

Name	Description
input ListRecommendationsInput!

listRoles

Type: ListRolesResult

List all DataHub Roles

Arguments

Name	Description
input ListRolesInput!

listSecrets

Type: ListSecretsResult

List all secrets stored in DataHub (no values)

Arguments

Name	Description
input ListSecretsInput!

listTests

Type: ListTestsResult

List all DataHub Tests

Arguments

Name	Description
input ListTestsInput!

listUsers

Type: ListUsersResult

List all DataHub Users

Arguments

Name	Description
input ListUsersInput!

me

Type: AuthenticatedUser

Fetch details associated with the authenticated user, provided via an auth cookie or header

mlFeature

Type: MLFeature

Incubating: Fetch a ML Feature by primary key (urn)

Arguments

Name	Description
urn String!

mlFeatureTable

Type: MLFeatureTable

Incubating: Fetch a ML Feature Table by primary key (urn)

Arguments

Name	Description
urn String!

mlModel

Type: MLModel

Incubating: Fetch an ML Model by primary key (urn)

Arguments

Name	Description
urn String!

mlModelGroup

Type: MLModelGroup

Incubating: Fetch an ML Model Group by primary key (urn)

Arguments

Name	Description
urn String!

mlPrimaryKey

Type: MLPrimaryKey

Incubating: Fetch a ML Primary Key by primary key (urn)

Arguments

Name	Description
urn String!

notebook

Type: Notebook

Fetch a Notebook by primary key (urn)

Arguments

Name	Description
urn String!

scrollAcrossEntities

Type: ScrollResults

Search DataHub entities by providing a pointer reference for scrolling through results.

Arguments

Name	Description
input ScrollAcrossEntitiesInput!

scrollAcrossLineage

Type: ScrollAcrossLineageResults

Search across the results of a graph query on a node, uses scroll API

Arguments

Name	Description
input ScrollAcrossLineageInput!

search

Type: SearchResults

Full text search against a specific DataHub Entity Type

Arguments

Name	Description
input SearchInput!

searchAcrossEntities

Type: SearchResults

Search DataHub entities

Arguments

Name	Description
input SearchAcrossEntitiesInput!

searchAcrossLineage

Type: SearchAcrossLineageResults

Search across the results of a graph query on a node

Arguments

Name	Description
input SearchAcrossLineageInput!

tag

Type: Tag

Fetch a Tag by primary key (urn)

Arguments

Name	Description
urn String!

test

Type: Test

Fetch a Test by primary key (urn)

Arguments

Name	Description
urn String!

versionedDataset

Type: VersionedDataset

Fetch a Dataset by primary key (urn) at a point in time based on aspect versions (versionStamp)

Arguments

Name	Description
urn String!
versionStamp String