Objects

Access

Fields

Name	Description
roles [RoleAssociation!]

AccessToken

Fields

Name	Description
accessToken String!	The access token itself
metadata AccessTokenMetadata	Metadata about the generated token

AccessTokenMetadata

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the access token
type EntityType!	The standard Entity Type
id String!	The unique identifier of the token.
name String!	The name of the token, if it exists.
description String	The description of the token if defined.
actorUrn String!	The actor associated with the Access Token.
ownerUrn String!	The actor who created the Access Token.
createdAt Long!	The time when token was generated at.
expiresAt Long	Time when token will be expired.
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!

Actor

Fields

Name	Description
users [RoleUser!]	List of users for which the role is provisioned

ActorFilter

The actors that a DataHub Access Policy applies to

Fields

Name	Description
users [String!]	A disjunctive set of users to apply the policy to
groups [String!]	A disjunctive set of groups to apply the policy to
roles [String!]	A disjunctive set of roles to apply the policy to
resourceOwners Boolean!	Whether the filter should return TRUE for owners of a particular resource Only applies to policies of type METADATA, which have a resource associated with them
resourceOwnersTypes [String!]	Set of OwnershipTypes to apply the policy to (if resourceOwners field is set to True)
resolvedOwnershipTypes [OwnershipTypeEntity!]	Set of OwnershipTypes to apply the policy to (if resourceOwners field is set to True), resolved.
allUsers Boolean!	Whether the filter should apply to all users
allGroups Boolean!	Whether the filter should apply to all groups
resolvedUsers [CorpUser!]	The list of users on the Policy, resolved.
resolvedGroups [CorpGroup!]	The list of groups on the Policy, resolved.
resolvedRoles [DataHubRole!]	The list of roles on the Policy, resolved.

AggregateResults

Results returned from aggregateAcrossEntities

Fields

Name	Description
facets [FacetMetadata!]	Candidate facet aggregations used for search filtering

AggregationMetadata

Information about the aggregation that can be used for filtering, included the field value and number of results

Fields

Name	Description
value String!	A particular value of a facet field
count Long!	The number of search results containing the value
entity Entity	Entity corresponding to the facet field

AllowedValue

An entry for an allowed value for a structured property

Fields

Name	Description
value PropertyValue!	The allowed value
description String	The description of this allowed value

AnalyticsChartGroup

For consumption by UI only

Fields

Name	Description
groupId String!
title String!
charts [AnalyticsChart!]!

AnalyticsConfig

Configurations related to the Analytics Feature

Fields

Name	Description
enabled Boolean!	Whether the Analytics feature is enabled and should be displayed

AppConfig

Config loaded at application boot time This configuration dictates the behavior of the UI, such as which features are enabled or disabled

Fields

Name	Description
appVersion String	App version
authConfig AuthConfig!	Auth-related configurations
analyticsConfig AnalyticsConfig!	Configurations related to the Analytics Feature
policiesConfig PoliciesConfig!	Configurations related to the Policies Feature
identityManagementConfig IdentityManagementConfig!	Configurations related to the User & Group management
managedIngestionConfig ManagedIngestionConfig!	Configurations related to UI-based ingestion
lineageConfig LineageConfig!	Configurations related to Lineage
visualConfig VisualConfig!	Configurations related to visual appearance, allows styling the UI without rebuilding the bundle
telemetryConfig TelemetryConfig!	Configurations related to tracking users in the app
testsConfig TestsConfig!	Configurations related to DataHub tests
viewsConfig ViewsConfig!	Configurations related to DataHub Views
featureFlags FeatureFlagsConfig!	Feature flags telling the UI whether a feature is enabled or not

AspectRenderSpec

Details for the frontend on how the raw aspect should be rendered

Fields

Name	Description
displayType String	Format the aspect should be displayed in for the UI. Powered by the renderSpec annotation on the aspect model
displayName String	Name to refer to the aspect type by for the UI. Powered by the renderSpec annotation on the aspect model
key String	Field in the aspect payload to index into for rendering.

Assertion

An assertion represents a programmatic validation, check, or test performed periodically against another Entity.

Implements

• EntityWithRelationships
• Entity

Fields

Name	Description
urn String!	The primary key of the Assertion
type EntityType!	The standard Entity Type
platform DataPlatform!	Standardized platform urn where the assertion is evaluated
info AssertionInfo	Details about assertion
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
runEvents AssertionRunEventsResult	Lifecycle events detailing individual runs of this assertion. If startTimeMillis & endTimeMillis are not provided, the most recent events will be returned. Arguments Name Description status AssertionRunStatus startTimeMillis Long endTimeMillis Long filter FilterInput limit Int
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
status Status	Status metadata of the assertion
aspects [RawAspect!]	Experimental API. For fetching extra aspects that do not have custom UI code yet Arguments Name Description input AspectParams

AssertionInfo

Type of assertion. Assertion types can evolve to span Datasets, Flows (Pipelines), Models, Features etc.

Fields

Name	Description
type AssertionType!	Top-level type of the assertion.
datasetAssertion DatasetAssertionInfo	Dataset-specific assertion information
description String	An optional human-readable description of the assertion

AssertionResult

The result of evaluating an assertion.

Fields

Name	Description
type AssertionResultType!	The final result, e.g. either SUCCESS or FAILURE.
rowCount Long	Number of rows for evaluated batch
missingCount Long	Number of rows with missing value for evaluated batch
unexpectedCount Long	Number of rows with unexpected value for evaluated batch
actualAggValue Float	Observed aggregate value for evaluated batch
externalUrl String	URL where full results are available
nativeResults [StringMapEntry!]	Native results / properties of evaluation

AssertionRunEvent

An event representing an event in the assertion evaluation lifecycle.

Implements

• TimeSeriesAspect

Fields

Name	Description
timestampMillis Long!	The time at which the assertion was evaluated
assertionUrn String!	Urn of assertion which is evaluated
asserteeUrn String!	Urn of entity on which the assertion is applicable
runId String!	Native (platform-specific) identifier for this run
status AssertionRunStatus!	The status of the assertion run as per this timeseries event.
batchSpec BatchSpec	Specification of the batch which this run is evaluating
partitionSpec PartitionSpec	Information about the partition that was evaluated
runtimeContext [StringMapEntry!]	Runtime parameters of evaluation
result AssertionResult	Results of assertion, present if the status is COMPLETE

AssertionRunEventsResult

Result returned when fetching run events for an assertion.

Fields

Name	Description
total Int!	The total number of run events returned
failed Int!	The number of failed run events
succeeded Int!	The number of succeeded run events
runEvents [AssertionRunEvent!]!	The run events themselves

AssertionStdParameter

Parameter for AssertionStdOperator.

Fields

Name	Description
value String!	The parameter value
type AssertionStdParameterType!	The type of the parameter

AssertionStdParameters

Parameters for AssertionStdOperators

Fields

Name	Description
value AssertionStdParameter	The value parameter of an assertion
maxValue AssertionStdParameter	The maxValue parameter of an assertion
minValue AssertionStdParameter	The minValue parameter of an assertion

AuditStamp

A time stamp along with an optional actor

Fields

Name	Description
time Long!	When the audited action took place
actor String	Who performed the audited action

AuthConfig

Configurations related to auth

Fields

Name	Description
tokenAuthEnabled Boolean!	Whether token-based auth is enabled.

AuthenticatedUser

Information about the currently authenticated user

Fields

Name	Description
corpUser CorpUser!	The user information associated with the authenticated user, including properties used in rendering the profile
platformPrivileges PlatformPrivileges!	The privileges assigned to the currently authenticated user, which dictates which parts of the UI they should be able to use

AutoCompleteMultipleResults

The results returned on a multi entity autocomplete query

Fields

Name	Description
query String!	The raw query string
suggestions [AutoCompleteResultForEntity!]!	The autocompletion suggestions

AutoCompleteResultForEntity

An individual auto complete result specific to an individual Metadata Entity Type

Fields

Name	Description
type EntityType!	Entity type
suggestions [String!]!	The autocompletion results for specified entity type
entities [Entity!]!	A list of entities to render in autocomplete

AutoCompleteResults

The results returned on a single entity autocomplete query

Fields

Name	Description
query String!	The query string
suggestions [String!]!	The autocompletion results
entities [Entity!]!	A list of entities to render in autocomplete

BarChart

For consumption by UI only

Fields

Name	Description
title String!
bars [NamedBar!]!

BarSegment

For consumption by UI only

Fields

Name	Description
label String!
value Int!

BaseData

Fields

Name	Description
dataset String!	Dataset used for the Training or Evaluation of the MLModel
motivation String	Motivation to pick these datasets
preProcessing [String!]	Details of Data Proprocessing

BatchGetStepStatesResult

Result returned when fetching step state

Fields

Name	Description
results [StepStateResult!]!	The step states

BatchSpec

Fields

Name	Description
nativeBatchId String	The native identifier as specified by the system operating on the batch.
query String	A query that identifies a batch of data
limit Int	Any limit to the number of rows in the batch, if applied
customProperties [StringMapEntry!]	Custom properties of the Batch

BatchUpdateStepStatesResult

Result returned when fetching step state

Fields

Name	Description
results [UpdateStepStateResult!]!	Results for each step

BooleanBox

Fields

Name	Description
booleanValue Boolean!

BrowsePath

A hierarchical entity path

Fields

Name	Description
path [String!]!	The components of the browse path

BrowsePathEntry

Fields

Name	Description
name String!	The path name of a group of browse results
entity Entity	An optional entity associated with this browse entry. This will usually be a container entity. If this entity is not populated, the name must be used.

BrowsePathV2

A hierarchical entity path V2

Fields

Name	Description
path [BrowsePathEntry!]!	The components of the browse path

BrowseResultGroup

A group of Entities under a given browse path

Fields

Name	Description
name String!	The path name of a group of browse results
count Long!	The number of entities within the group

BrowseResultGroupV2

A group of Entities under a given browse path

Fields

Name	Description
name String!	The path name of a group of browse results
entity Entity	An optional entity associated with this browse group. This will usually be a container entity. If this entity is not populated, the name must be used.
count Long!	The number of entities within the group
hasSubGroups Boolean!	Whether or not there are any more groups underneath this group

BrowseResultMetadata

Metadata about the Browse Paths response

Fields

Name	Description
path [String!]!	The provided path
totalNumEntities Long!	The total number of entities under the provided browse path

BrowseResults

The results of a browse path traversal query

Fields

Name	Description
entities [Entity!]!	The browse results
groups [BrowseResultGroup!]!	The groups present at the provided browse path
start Int!	The starting point of paginated results
count Int!	The number of elements included in the results
total Int!	The total number of browse results under the path with filters applied
metadata BrowseResultMetadata!	Metadata containing resulting browse groups

BrowseResultsV2

The results of a browse path V2 traversal query

Fields

Name	Description
groups [BrowseResultGroupV2!]!	The groups present at the provided browse path V2
start Int!	The starting point of paginated results
count Int!	The number of groups included in the results
total Int!	The total number of browse groups under the path with filters applied
metadata BrowseResultMetadata!	Metadata containing resulting browse groups

BusinessAttribute

A Business Attribute, or a logical schema Field

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the Data Product
type EntityType!	A standard Entity Type
properties BusinessAttributeInfo	Properties about a Business Attribute
ownership Ownership	Ownership metadata of the Business Attribute
institutionalMemory InstitutionalMemory	References to internal resources related to Business Attribute
status Status	Status of the Dataset
relationships EntityRelationshipsResult	List of relationships between the source Entity and some destination entities with a given types Arguments Name Description input RelationshipsInput!

BusinessAttributeAssociation

Input required to attach business attribute to an entity

Fields

Name	Description
businessAttribute BusinessAttribute!	Business Attribute itself
associatedUrn String!	Reference back to the associated urn for tracking purposes e.g. when sibling nodes are merged together

BusinessAttributeInfo

Business Attribute type

Fields

Name	Description
name String!	name of the business attribute
description String	description of business attribute
tags GlobalTags	Tags associated with the business attribute
glossaryTerms GlossaryTerms	Glossary terms associated with the business attribute
type SchemaFieldDataType	Platform independent field type of the field
customProperties [CustomPropertiesEntry!]	A list of platform specific metadata tuples
created AuditStamp!	An AuditStamp corresponding to the creation of this chart
lastModified AuditStamp!	An AuditStamp corresponding to the modification of this chart
deleted AuditStamp	An optional AuditStamp corresponding to the deletion of this chart

BusinessAttributes

Business attributes attached to the metadata

Fields

Name	Description
businessAttribute BusinessAttributeAssociation	Business Attribute attached to the Metadata Entity

CaveatDetails

Fields

Name	Description
needsFurtherTesting Boolean	Did the results suggest any further testing
caveatDescription String	Caveat Description
groupsNotRepresented [String!]	Relevant groups that were not represented in the evaluation dataset

CaveatsAndRecommendations

Fields

Name	Description
caveats CaveatDetails	Caveats on using this MLModel
recommendations String	Recommendations on where this MLModel should be used
idealDatasetCharacteristics [String!]	Ideal characteristics of an evaluation dataset for this MLModel

Cell

For consumption by UI only

Fields

Name	Description
value String!
entity Entity
linkParams LinkParams

ChangeAuditStamps

Captures information about who created/last modified/deleted the entity and when

Fields

Name	Description
created AuditStamp!	An AuditStamp corresponding to the creation
lastModified AuditStamp!	An AuditStamp corresponding to the modification
deleted AuditStamp	An optional AuditStamp corresponding to the deletion

Chart

A Chart Metadata Entity

Implements

• EntityWithRelationships
• Entity
• BrowsableEntity

Fields

Name	Description
urn String!	The primary key of the Chart
type EntityType!	A standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
container Container	The parent container in which the entity resides
parentContainers ParentContainersResult	Recursively get the lineage of containers for this entity
tool String!	The chart tool name Note that this field will soon be deprecated in favor a unified notion of Data Platform
chartId String!	An id unique within the charting tool
properties ChartProperties	Additional read only properties about the Chart
editableProperties ChartEditableProperties	Additional read write properties about the Chart
query ChartQuery	Info about the query which is used to render the chart
ownership Ownership	Ownership metadata of the chart
status Status	Status metadata of the chart
deprecation Deprecation	The deprecation status of the chart
embed Embed	Embed information about the Chart
tags GlobalTags	The tags associated with the chart
institutionalMemory InstitutionalMemory	References to internal resources related to the dashboard
glossaryTerms GlossaryTerms	The structured glossary terms associated with the dashboard
domain DomainAssociation	The Domain associated with the Chart
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
statsSummary ChartStatsSummary	Not yet implemented. Experimental - Summary operational & usage statistics about a Chart
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
browsePaths [BrowsePath!]	The browse paths corresponding to the chart. If no Browse Paths have been generated before, this will be null.
browsePathV2 BrowsePathV2	The browse path V2 corresponding to an entity. If no Browse Paths V2 have been generated before, this will be null.
info ChartInfo	Deprecated: No longer supported Deprecated, use properties field instead Additional read only information about the chart
editableInfo ChartEditableProperties	Deprecated: No longer supported Deprecated, use editableProperties field instead Additional read write information about the Chart
globalTags GlobalTags	Deprecated: No longer supported Deprecated, use tags instead The structured tags associated with the chart
platform DataPlatform!	Standardized platform urn where the chart is defined
inputFields InputFields	Input fields to power the chart
privileges EntityPrivileges	Privileges given to a user relevant to this entity
exists Boolean	Whether or not this entity exists on DataHub
subTypes SubTypes	Sub Types that this entity implements
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
health [Health!]	Experimental! The resolved health statuses of the asset
forms Forms	The forms associated with the Dataset

ChartCell

A Notebook cell which contains chart as content

Fields

Name	Description
cellTitle String!	Title of the cell
cellId String!	Unique id for the cell.
changeAuditStamps ChangeAuditStamps	Captures information about who created/last modified/deleted this TextCell and when

ChartEditableProperties

Chart properties that are editable via the UI This represents logical metadata, as opposed to technical metadata

Fields

Name	Description
description String	Description of the Chart

ChartInfo

Deprecated, use ChartProperties instead Additional read only information about the chart

Fields

Name	Description
name String!	Display name of the chart
description String	Description of the chart
inputs [Dataset!]	Deprecated: No longer supported Deprecated, use relationship Consumes instead Data sources for the chart
externalUrl String	Native platform URL of the chart
type ChartType	Access level for the chart
access AccessLevel	Access level for the chart
customProperties [CustomPropertiesEntry!]	A list of platform specific metadata tuples
lastRefreshed Long	The time when this chart last refreshed
created AuditStamp!	An AuditStamp corresponding to the creation of this chart
lastModified AuditStamp!	An AuditStamp corresponding to the modification of this chart
deleted AuditStamp	An optional AuditStamp corresponding to the deletion of this chart

ChartProperties

Additional read only properties about the chart

Fields

Name	Description
name String!	Display name of the chart
description String	Description of the chart
externalUrl String	Native platform URL of the chart
type ChartType	Access level for the chart
access AccessLevel	Access level for the chart
customProperties [CustomPropertiesEntry!]	A list of platform specific metadata tuples
lastRefreshed Long	The time when this chart last refreshed
created AuditStamp!	An AuditStamp corresponding to the creation of this chart
lastModified AuditStamp!	An AuditStamp corresponding to the modification of this chart
deleted AuditStamp	An optional AuditStamp corresponding to the deletion of this chart

ChartQuery

The query that was used to populate a Chart

Fields

Name	Description
rawQuery String!	Raw query to build a chart from input datasets
type ChartQueryType!	The type of the chart query

ChartStatsSummary

Experimental - subject to change. A summary of usage metrics about a Chart.

Fields

Name	Description
viewCount Int	The total view count for the chart
viewCountLast30Days Int	The view count in the last 30 days
uniqueUserCountLast30Days Int	The unique user count in the past 30 days
topUsersLast30Days [CorpUser!]	The top users in the past 30 days

Container

A container of other Metadata Entities

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the container
type EntityType!	A standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
platform DataPlatform!	Standardized platform.
container Container	Fetch an Entity Container by primary key (urn)
parentContainers ParentContainersResult	Recursively get the lineage of containers for this entity
properties ContainerProperties	Read-only properties that originate in the source data platform
editableProperties ContainerEditableProperties	Read-write properties that originate in DataHub
ownership Ownership	Ownership metadata of the dataset
institutionalMemory InstitutionalMemory	References to internal resources related to the dataset
tags GlobalTags	Tags used for searching dataset
glossaryTerms GlossaryTerms	The structured glossary terms associated with the dataset
subTypes SubTypes	Sub types of the container, e.g. "Database" etc
domain DomainAssociation	The Domain associated with the Dataset
deprecation Deprecation	The deprecation status of the container
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
entities SearchResults	Children entities inside of the Container Arguments Name Description input ContainerEntitiesInput
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!
status Status	Status metadata of the container
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

ContainerEditableProperties

Read-write properties that originate in DataHub

Fields

Name	Description
description String	DataHub description of the Container

ContainerProperties

Read-only properties that originate in the source data platform

Fields

Name	Description
name String!	Display name of the Container
description String	System description of the Container
customProperties [CustomPropertiesEntry!]	Custom properties of the Container
externalUrl String	Native platform URL of the Container
qualifiedName String	Fully-qualified name of the Container

ContentParams

Params about the recommended content

Fields

Name	Description
count Long	Number of entities corresponding to the recommended content

CorpGroup

A DataHub Group entity, which represents a Person on the Metadata Entity Graph

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the group
type EntityType!	A standard Entity Type
name String!	Group name eg wherehows dev, ask_metadata
ownership Ownership	Ownership metadata of the Corp Group
properties CorpGroupProperties	Additional read only properties about the group
editableProperties CorpGroupEditableProperties	Additional read write properties about the group
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
origin Origin	Origin info about this group.
info CorpGroupInfo	Deprecated: No longer supported Deprecated, use properties field instead Additional read only info about the group
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

CorpGroupEditableProperties

Additional read write properties about a group

Fields

Name	Description
description String	DataHub description of the group
slack String	Slack handle for the group
email String	Email address for the group
pictureLink String	A URL which points to a picture which user wants to set as a profile photo

CorpGroupInfo

Deprecated, use CorpUserProperties instead Additional read only info about a group

Fields

Name	Description
displayName String	The name to display when rendering the group
description String	The description provided for the group
email String	email of this group
admins [CorpUser!]	Deprecated: No longer supported Deprecated, do not use owners of this group
members [CorpUser!]	Deprecated: No longer supported Deprecated, use relationship IsMemberOfGroup instead List of ldap urn in this group
groups [String!]	Deprecated: No longer supported Deprecated, do not use List of groups urns in this group

CorpGroupProperties

Additional read only properties about a group

Fields

Name	Description
displayName String	display name of this group
description String	The description provided for the group
email String	email of this group
slack String	Slack handle for the group

CorpUser

A DataHub User entity, which represents a Person on the Metadata Entity Graph

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the user
type EntityType!	The standard Entity Type
username String!	A username associated with the user This uniquely identifies the user within DataHub
properties CorpUserProperties	Additional read only properties about the corp user
editableProperties CorpUserEditableProperties	Read write properties about the corp user
status CorpUserStatus	The status of the user
tags GlobalTags	The tags associated with the user
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
isNativeUser Boolean	Whether or not this user is a native DataHub user
info CorpUserInfo	Deprecated: No longer supported Deprecated, use properties field instead Additional read only info about the corp user
editableInfo CorpUserEditableInfo	Deprecated: No longer supported Deprecated, use editableProperties field instead Read write info about the corp user
globalTags GlobalTags	Deprecated: No longer supported Deprecated, use the tags field instead The structured tags associated with the user
exists Boolean	Whether or not this entity exists on DataHub
settings CorpUserSettings	Settings that a user can customize through the datahub ui
aspects [RawAspect!]	Experimental API. For fetching extra aspects that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

CorpUserAppearanceSettings

Settings that control look and feel of the DataHub UI for the user

Fields

Name	Description
showSimplifiedHomepage Boolean	Flag whether the user should see a homepage with only datasets, charts & dashboards. Intended for users who have less operational use cases for the datahub tool.

CorpUserEditableInfo

Deprecated, use CorpUserEditableProperties instead Additional read write info about a user

Fields

Name	Description
displayName String	Display name to show on DataHub
title String	Title to show on DataHub
aboutMe String	About me section of the user
teams [String!]	Teams that the user belongs to
skills [String!]	Skills that the user possesses
pictureLink String	A URL which points to a picture which user wants to set as a profile photo

CorpUserEditableProperties

Additional read write properties about a user

Fields

Name	Description
displayName String	Display name to show on DataHub
title String	Title to show on DataHub
aboutMe String	About me section of the user
teams [String!]	Teams that the user belongs to
skills [String!]	Skills that the user possesses
pictureLink String	A URL which points to a picture which user wants to set as a profile photo
slack String	The slack handle of the user
phone String	Phone number for the user
email String	Email address for the user

CorpUserInfo

Deprecated, use CorpUserProperties instead Additional read only info about a user

Fields

Name	Description
active Boolean!	Whether the user is active
displayName String	Display name of the user
email String	Email address of the user
title String	Title of the user
manager CorpUser	Direct manager of the user
departmentId Long	department id the user belong to
departmentName String	department name this user belong to
firstName String	first name of the user
lastName String	last name of the user
fullName String	Common name of this user, format is firstName plus lastName
countryCode String	two uppercase letters country code
customProperties [CustomPropertiesEntry!]	Custom properties of the ldap

CorpUserProperties

Additional read only properties about a user

Fields

Name	Description
active Boolean!	Whether the user is active
displayName String	Display name of the user
email String	Email address of the user
title String	Title of the user
manager CorpUser	Direct manager of the user
departmentId Long	department id the user belong to
departmentName String	department name this user belong to
firstName String	first name of the user
lastName String	last name of the user
fullName String	Common name of this user, format is firstName plus lastName
countryCode String	two uppercase letters country code
customProperties [CustomPropertiesEntry!]	Custom properties of the ldap

CorpUserSettings

Settings that a user can customize through the datahub ui

Fields

Name	Description
appearance CorpUserAppearanceSettings	Settings that control look and feel of the DataHub UI for the user
views CorpUserViewsSettings	Settings related to the DataHub Views feature

CorpUserViewsSettings

Settings related to the Views feature of DataHub.

Fields

Name	Description
defaultView DataHubView	The default view for the User.

Cost

Fields

Name	Description
costType CostType!	Type of Cost Code
costValue CostValue!	Code to which the Cost of this entity should be attributed to ie organizational cost ID

CostValue

Fields

Name	Description
costId Float	Organizational Cost ID
costCode String	Organizational Cost Code

CustomPropertiesEntry

An entry in a custom properties map represented as a tuple

Fields

Name	Description
key String!	The key of the map entry
value String	The value fo the map entry
associatedUrn String!	The urn of the entity this property came from for tracking purposes e.g. when sibling nodes are merged together

Dashboard

A Dashboard Metadata Entity

Implements

• EntityWithRelationships
• Entity
• BrowsableEntity

Fields

Name	Description
urn String!	The primary key of the Dashboard
type EntityType!	A standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
container Container	The parent container in which the entity resides
parentContainers ParentContainersResult	Recursively get the lineage of containers for this entity
tool String!	The dashboard tool name Note that this will soon be deprecated in favor of a standardized notion of Data Platform
dashboardId String!	An id unique within the dashboard tool
properties DashboardProperties	Additional read only properties about the dashboard
editableProperties DashboardEditableProperties	Additional read write properties about the dashboard
ownership Ownership	Ownership metadata of the dashboard
status Status	Status metadata of the dashboard
embed Embed	Embed information about the Dashboard
deprecation Deprecation	The deprecation status of the dashboard
tags GlobalTags	The tags associated with the dashboard
institutionalMemory InstitutionalMemory	References to internal resources related to the dashboard
glossaryTerms GlossaryTerms	The structured glossary terms associated with the dashboard
domain DomainAssociation	The Domain associated with the Dashboard
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
browsePaths [BrowsePath!]	The browse paths corresponding to the dashboard. If no Browse Paths have been generated before, this will be null.
browsePathV2 BrowsePathV2	The browse path V2 corresponding to an entity. If no Browse Paths V2 have been generated before, this will be null.
usageStats DashboardUsageQueryResult	Experimental (Subject to breaking change) -- Statistics about how this Dashboard is used Arguments Name Description startTimeMillis Long endTimeMillis Long limit Int
statsSummary DashboardStatsSummary	Experimental - Summary operational & usage statistics about a Dashboard
info DashboardInfo	Deprecated: No longer supported Deprecated, use properties field instead Additional read only information about the dashboard
editableInfo DashboardEditableProperties	Deprecated: No longer supported Deprecated, use editableProperties instead Additional read write properties about the Dashboard
globalTags GlobalTags	Deprecated: No longer supported Deprecated, use tags field instead The structured tags associated with the dashboard
platform DataPlatform!	Standardized platform urn where the dashboard is defined
inputFields InputFields	Input fields that power all the charts in the dashboard
subTypes SubTypes	Sub Types of the dashboard
privileges EntityPrivileges	Privileges given to a user relevant to this entity
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
health [Health!]	Experimental! The resolved health statuses of the asset
forms Forms	The forms associated with the Dataset

DashboardEditableProperties

Dashboard properties that are editable via the UI This represents logical metadata, as opposed to technical metadata

Fields

Name	Description
description String	Description of the Dashboard

DashboardInfo

Deprecated, use DashboardProperties instead Additional read only info about a Dashboard

Fields

Name	Description
name String!	Display of the dashboard
description String	Description of the dashboard
charts [Chart!]!	Deprecated: No longer supported Deprecated, use relationship Contains instead Charts that comprise the dashboard
externalUrl String	Native platform URL of the dashboard
access AccessLevel	Access level for the dashboard Note that this will soon be deprecated for low usage
customProperties [CustomPropertiesEntry!]	A list of platform specific metadata tuples
lastRefreshed Long	The time when this dashboard last refreshed
created AuditStamp!	An AuditStamp corresponding to the creation of this dashboard
lastModified AuditStamp!	An AuditStamp corresponding to the modification of this dashboard
deleted AuditStamp	An optional AuditStamp corresponding to the deletion of this dashboard

DashboardProperties

Additional read only properties about a Dashboard

Fields

Name	Description
name String!	Display of the dashboard
description String	Description of the dashboard
externalUrl String	Native platform URL of the dashboard
access AccessLevel	Access level for the dashboard Note that this will soon be deprecated for low usage
customProperties [CustomPropertiesEntry!]	A list of platform specific metadata tuples
lastRefreshed Long	The time when this dashboard last refreshed
created AuditStamp!	An AuditStamp corresponding to the creation of this dashboard
lastModified AuditStamp!	An AuditStamp corresponding to the modification of this dashboard
deleted AuditStamp	An optional AuditStamp corresponding to the deletion of this dashboard

DashboardStatsSummary

Experimental - subject to change. A summary of usage metrics about a Dashboard.

Fields

Name	Description
viewCount Int	The total view count for the dashboard
viewCountLast30Days Int	The view count in the last 30 days
uniqueUserCountLast30Days Int	The unique user count in the past 30 days
topUsersLast30Days [CorpUser!]	The top users in the past 30 days

DashboardUsageAggregation

An aggregation of Dashboard usage statistics

Fields

Name	Description
bucket Long	The time window start time
duration WindowDuration	The time window span
resource String	The resource urn associated with the usage information, eg a Dashboard urn
metrics DashboardUsageAggregationMetrics	The rolled up usage metrics

DashboardUsageAggregationMetrics

Rolled up metrics about Dashboard usage over time

Fields

Name	Description
uniqueUserCount Int	The unique number of dashboard users within the time range
viewsCount Int	The total number of dashboard views within the time range
executionsCount Int	The total number of dashboard executions within the time range

DashboardUsageMetrics

A set of absolute dashboard usage metrics

Implements

• TimeSeriesAspect

Fields

Name	Description
timestampMillis Long!	The time at which the metrics were reported
favoritesCount Int	The total number of times dashboard has been favorited FIXME: Qualifies as Popularity Metric rather than Usage Metric?
viewsCount Int	The total number of dashboard views
executionsCount Int	The total number of dashboard execution
lastViewed Long	The time when this dashboard was last viewed

DashboardUsageQueryResult

The result of a dashboard usage query

Fields

Name	Description
buckets [DashboardUsageAggregation]	A set of relevant time windows for use in displaying usage statistics
aggregations DashboardUsageQueryResultAggregations	A set of rolled up aggregations about the dashboard usage
metrics [DashboardUsageMetrics!]	A set of absolute dashboard usage metrics

DashboardUsageQueryResultAggregations

A set of rolled up aggregations about the Dashboard usage

Fields

Name	Description
uniqueUserCount Int	The count of unique Dashboard users within the queried time range
users [DashboardUserUsageCounts]	The specific per user usage counts within the queried time range
viewsCount Int	The total number of dashboard views within the queried time range
executionsCount Int	The total number of dashboard executions within the queried time range

DashboardUserUsageCounts

Information about individual user usage of a Dashboard

Fields

Name	Description
user CorpUser	The user of the Dashboard
viewsCount Int	number of times dashboard has been viewed by the user
executionsCount Int	number of dashboard executions by the user
usageCount Int	Normalized numeric metric representing user's dashboard usage Higher value represents more usage

DataFlow

A Data Flow Metadata Entity, representing an set of pipelined Data Job or Tasks required to produce an output Dataset Also known as a Data Pipeline

Implements

• EntityWithRelationships
• Entity
• BrowsableEntity

Fields

Name	Description
urn String!	The primary key of a Data Flow
type EntityType!	A standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
orchestrator String!	Workflow orchestrator ei Azkaban, Airflow
flowId String!	Id of the flow
cluster String!	Cluster of the flow
properties DataFlowProperties	Additional read only properties about a Data flow
editableProperties DataFlowEditableProperties	Additional read write properties about a Data Flow
ownership Ownership	Ownership metadata of the flow
tags GlobalTags	The tags associated with the dataflow
status Status	Status metadata of the dataflow
deprecation Deprecation	The deprecation status of the Data Flow
institutionalMemory InstitutionalMemory	References to internal resources related to the dashboard
glossaryTerms GlossaryTerms	The structured glossary terms associated with the dashboard
domain DomainAssociation	The Domain associated with the DataFlow
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
browsePaths [BrowsePath!]	The browse paths corresponding to the data flow. If no Browse Paths have been generated before, this will be null.
browsePathV2 BrowsePathV2	The browse path V2 corresponding to an entity. If no Browse Paths V2 have been generated before, this will be null.
info DataFlowInfo	Deprecated: No longer supported Deprecated, use properties field instead Additional read only information about a Data flow
globalTags GlobalTags	Deprecated: No longer supported Deprecated, use tags field instead The structured tags associated with the dataflow
dataJobs DataFlowDataJobsRelationships	Deprecated: No longer supported Deprecated, use relationship IsPartOf instead Data Jobs
platform DataPlatform!	Standardized platform urn where the datflow is defined
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
health [Health!]	Experimental! The resolved health statuses of the asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

DataFlowDataJobsRelationships

Deprecated, use relationships query instead

Fields

Name	Description
entities [EntityRelationshipLegacy]

DataFlowEditableProperties

Data Flow properties that are editable via the UI This represents logical metadata, as opposed to technical metadata

Fields

Name	Description
description String	Description of the Data Flow

DataFlowInfo

Deprecated, use DataFlowProperties instead Additional read only properties about a Data Flow aka Pipeline

Fields

Name	Description
name String!	Display name of the flow
description String	Description of the flow
project String	Optional project or namespace associated with the flow
externalUrl String	External URL associated with the DataFlow
customProperties [CustomPropertiesEntry!]	A list of platform specific metadata tuples

DataFlowProperties

Additional read only properties about a Data Flow aka Pipeline

Fields

Name	Description
name String!	Display name of the flow
description String	Description of the flow
project String	Optional project or namespace associated with the flow
externalUrl String	External URL associated with the DataFlow
customProperties [CustomPropertiesEntry!]	A list of platform specific metadata tuples

DataHubPolicy

An DataHub Platform Access Policy - Policies determine who can perform what actions against which resources on the platform

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the Policy
type EntityType!	The standard Entity Type
relationships EntityRelationshipsResult	Granular API for querying edges extending from the Role Arguments Name Description input RelationshipsInput!
policyType PolicyType!	The type of the Policy
name String!	The name of the Policy
state PolicyState!	The present state of the Policy
description String	The description of the Policy
resources ResourceFilter	The resources that the Policy privileges apply to
privileges [String!]!	The privileges that the Policy grants
actors ActorFilter!	The actors that the Policy grants privileges to
editable Boolean!	Whether the Policy is editable, ie system policies, or not

DataHubRole

A DataHub Role is a high-level abstraction on top of Policies that dictates what actions users can take.

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the role
type EntityType!	The standard Entity Type
relationships EntityRelationshipsResult	Granular API for querying edges extending from the Role Arguments Name Description input RelationshipsInput!
name String!	The name of the Role.
description String!	The description of the Role
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams

DataHubView

An DataHub View - Filters that are applied across the application automatically.

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the View
type EntityType!	The standard Entity Type
viewType DataHubViewType!	The type of the View
name String!	The name of the View
description String	The description of the View
definition DataHubViewDefinition!	The definition of the View
relationships EntityRelationshipsResult	Granular API for querying edges extending from the View Arguments Name Description input RelationshipsInput!

DataHubViewDefinition

An DataHub View Definition

Fields

Name	Description
entityTypes [EntityType!]!	A set of filters to apply. If left empty, then ALL entity types are in scope.
filter DataHubViewFilter!	A set of filters to apply. If left empty, then no filters will be applied.

DataHubViewFilter

A DataHub View Filter. Note that

Fields

Name	Description
operator LogicalOperator!	The operator used to combine the filters.
filters [FacetFilter!]!	A set of filters combined using the operator. If left empty, then no filters will be applied.

DataJob

A Data Job Metadata Entity, representing an individual unit of computation or Task to produce an output Dataset Always part of a parent Data Flow aka Pipeline

Implements

• EntityWithRelationships
• Entity
• BrowsableEntity

Fields

Name	Description
urn String!	The primary key of the Data Job
type EntityType!	A standard Entity Type
subTypes SubTypes	Sub Types that this entity implements
lastIngested Long	The timestamp for the last time this entity was ingested
dataFlow DataFlow	Deprecated, use relationship IsPartOf instead The associated data flow
jobId String!	Id of the job
properties DataJobProperties	Additional read only properties associated with the Data Job
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
editableProperties DataJobEditableProperties	Additional read write properties associated with the Data Job
tags GlobalTags	The tags associated with the DataJob
ownership Ownership	Ownership metadata of the job
status Status	Status metadata of the DataJob
deprecation Deprecation	The deprecation status of the Data Flow
institutionalMemory InstitutionalMemory	References to internal resources related to the dashboard
glossaryTerms GlossaryTerms	The structured glossary terms associated with the dashboard
domain DomainAssociation	The Domain associated with the Data Job
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
browsePaths [BrowsePath!]	The browse paths corresponding to the data job. If no Browse Paths have been generated before, this will be null.
browsePathV2 BrowsePathV2	The browse path V2 corresponding to an entity. If no Browse Paths V2 have been generated before, this will be null.
info DataJobInfo	Deprecated: No longer supported Deprecated, use properties field instead Additional read only information about a Data processing job
inputOutput DataJobInputOutput	Information about the inputs and outputs of a Data processing job including column-level lineage.
globalTags GlobalTags	Deprecated: No longer supported Deprecated, use the tags field instead The structured tags associated with the DataJob
runs DataProcessInstanceResult	History of runs of this task Arguments Name Description start Int count Int
privileges EntityPrivileges	Privileges given to a user relevant to this entity
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
health [Health!]	Experimental! The resolved health statuses of the asset
forms Forms	The forms associated with the Dataset

DataJobEditableProperties

Data Job properties that are editable via the UI This represents logical metadata, as opposed to technical metadata

Fields

Name	Description
description String	Description of the Data Job

DataJobInfo

Deprecated, use DataJobProperties instead Additional read only information about a Data Job aka Task

Fields

Name	Description
name String!	Job display name
description String	Job description
externalUrl String	External URL associated with the DataJob
customProperties [CustomPropertiesEntry!]	A list of platform specific metadata tuples

DataJobInputOutput

The lineage information for a DataJob TODO Rename this to align with other Lineage models

Fields

Name	Description
inputDatasets [Dataset!]	Deprecated: No longer supported Deprecated, use relationship Consumes instead Input datasets produced by the data job during processing
outputDatasets [Dataset!]	Deprecated: No longer supported Deprecated, use relationship Produces instead Output datasets produced by the data job during processing
inputDatajobs [DataJob!]	Deprecated: No longer supported Deprecated, use relationship DownstreamOf instead Input datajobs that this data job depends on
fineGrainedLineages [FineGrainedLineage!]	Lineage information for the column-level. Includes a list of objects detailing which columns are upstream and which are downstream of each other. The upstream and downstream columns are from datasets.

DataJobProperties

Additional read only properties about a Data Job aka Task

Fields

Name	Description
name String!	Job display name
description String	Job description
externalUrl String	External URL associated with the DataJob
customProperties [CustomPropertiesEntry!]	A list of platform specific metadata tuples

DataPlatform

A Data Platform represents a specific third party Data System or Tool Examples include warehouses like Snowflake, orchestrators like Airflow, and dashboarding tools like Looker

Implements

• Entity

Fields

Name	Description
urn String!	Urn of the data platform
type EntityType!	A standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
name String!	Name of the data platform
properties DataPlatformProperties	Additional read only properties associated with a data platform
displayName String	Deprecated: No longer supported Deprecated, use properties displayName instead Display name of the data platform
info DataPlatformInfo	Deprecated: No longer supported Deprecated, use properties field instead Additional properties associated with a data platform
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!

DataPlatformInfo

Deprecated, use DataPlatformProperties instead Additional read only information about a Data Platform

Fields

Name	Description
type PlatformType!	The platform category
displayName String	Display name associated with the platform
datasetNameDelimiter String!	The delimiter in the dataset names on the data platform
logoUrl String	A logo URL associated with the platform

DataPlatformInstance

A Data Platform instance represents an instance of a 3rd party platform like Looker, Snowflake, etc.

Implements

• Entity

Fields

Name	Description
urn String!	Urn of the data platform
type EntityType!	A standard Entity Type
platform DataPlatform!	Name of the data platform
instanceId String!	The platform instance id
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!
properties DataPlatformInstanceProperties	Additional read only properties associated with a data platform instance
ownership Ownership	Ownership metadata of the data platform instance
institutionalMemory InstitutionalMemory	References to internal resources related to the data platform instance
tags GlobalTags	Tags used for searching the data platform instance
deprecation Deprecation	The deprecation status of the data platform instance
status Status	Status metadata of the container

DataPlatformInstanceProperties

Additional read only properties about a DataPlatformInstance

Fields

Name	Description
name String	The name of the data platform instance used in display
description String	Read only technical description for the data platform instance
customProperties [CustomPropertiesEntry!]	Custom properties of the data platform instance
externalUrl String	External URL associated with the data platform instance

DataPlatformProperties

Additional read only properties about a Data Platform

Fields

Name	Description
type PlatformType!	The platform category
displayName String	Display name associated with the platform
datasetNameDelimiter String!	The delimiter in the dataset names on the data platform
logoUrl String	A logo URL associated with the platform

DataProcessInstance

A DataProcessInstance Metadata Entity, representing an individual run of a task or datajob.

Implements

• EntityWithRelationships
• Entity

Fields

Name	Description
urn String!	The primary key of the DataProcessInstance
type EntityType!	The standard Entity Type
state [DataProcessRunEvent]	The history of state changes for the run Arguments Name Description startTimeMillis Long endTimeMillis Long limit Int
created AuditStamp	When the run was kicked off
name String	The name of the data process
relationships EntityRelationshipsResult	Edges extending from this entity. In the UI, used for inputs, outputs and parentTemplate Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
externalUrl String	The link to view the task run in the source system

DataProcessInstanceResult

Data Process instances that match the provided query

Fields

Name	Description
count Int	The number of entities to include in result set
start Int	The offset of the result set
total Int	The total number of run events returned
runs [DataProcessInstance]	The data process instances that produced or consumed the entity

DataProcessInstanceRunResult

the result of a run, part of the run state

Fields

Name	Description
resultType DataProcessInstanceRunResultType	The outcome of the run
nativeResultType String	The outcome of the run in the data platforms native language

DataProcessRunEvent

A state change event in the data process instance lifecycle

Implements

• TimeSeriesAspect

Fields

Name	Description
status DataProcessRunStatus	The status of the data process instance
attempt Int	The try number that this instance run is in
result DataProcessInstanceRunResult	The result of a run
timestampMillis Long!	The timestamp associated with the run event in milliseconds
durationMillis Long	The duration of the run in milliseconds

DataProduct

A Data Product, or a logical grouping of Metadata Entities

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the Data Product
type EntityType!	A standard Entity Type
properties DataProductProperties	Properties about a Data Product
ownership Ownership	Ownership metadata of the Data Product
institutionalMemory InstitutionalMemory	References to internal resources related to the Data Product
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!
entities SearchResults	Children entities inside of the DataProduct Arguments Name Description input SearchAcrossEntitiesInput
glossaryTerms GlossaryTerms	The structured glossary terms associated with the Data Product
domain DomainAssociation	The Domain associated with the Data Product
tags GlobalTags	Tags used for searching Data Product
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

DataProductProperties

Properties about a domain

Fields

Name	Description
name String!	Display name of the Data Product
description String	Description of the Data Product
externalUrl String	External URL for the DataProduct (most likely GitHub repo where Data Products are managed as code)
numAssets Int	Number of children entities inside of the Data Product. This number includes soft deleted entities.
customProperties [CustomPropertiesEntry!]	Custom properties of the Data Product

Dataset

A Dataset entity, which encompasses Relational Tables, Document store collections, streaming topics, and other sets of data having an independent lifecycle

Implements

• EntityWithRelationships
• Entity
• BrowsableEntity

Fields

Name	Description
urn String!	The primary key of the Dataset
type EntityType!	The standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
platform DataPlatform!	Standardized platform urn where the dataset is defined
container Container	The parent container in which the entity resides
parentContainers ParentContainersResult	Recursively get the lineage of containers for this entity
name String!	Unique guid for dataset No longer to be used as the Dataset display name. Use properties.name instead
properties DatasetProperties	An additional set of read only properties
editableProperties DatasetEditableProperties	An additional set of of read write properties
ownership Ownership	Ownership metadata of the dataset
deprecation Deprecation	The deprecation status of the dataset
institutionalMemory InstitutionalMemory	References to internal resources related to the dataset
schemaMetadata SchemaMetadata	Schema metadata of the dataset, available by version number Arguments Name Description version Long
editableSchemaMetadata EditableSchemaMetadata	Editable schema metadata of the dataset
status Status	Status of the Dataset
embed Embed	Embed information about the Dataset
tags GlobalTags	Tags used for searching dataset
glossaryTerms GlossaryTerms	The structured glossary terms associated with the dataset
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
domain DomainAssociation	The Domain associated with the Dataset
forms Forms	The forms associated with the Dataset
access Access	The Roles and the properties to access the dataset
usageStats UsageQueryResult	Statistics about how this Dataset is used The first parameter, resource, is deprecated and no longer needs to be provided Arguments Name Description resource String range TimeRange
statsSummary DatasetStatsSummary	Experimental - Summary operational & usage statistics about a Dataset
datasetProfiles [DatasetProfile!]	Profile Stats resource that retrieves the events in a previous unit of time in descending order If no start or end time are provided, the most recent events will be returned Arguments Name Description startTimeMillis Long endTimeMillis Long filter FilterInput limit Int
operations [Operation!]	Operational events for an entity. Arguments Name Description startTimeMillis Long endTimeMillis Long filter FilterInput limit Int
assertions EntityAssertionsResult	Assertions associated with the Dataset Arguments Name Description start Int count Int includeSoftDeleted Boolean
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
browsePaths [BrowsePath!]	The browse paths corresponding to the dataset. If no Browse Paths have been generated before, this will be null.
browsePathV2 BrowsePathV2	The browse path V2 corresponding to an entity. If no Browse Paths V2 have been generated before, this will be null.
health [Health!]	Experimental! The resolved health statuses of the Dataset
schema Schema	Deprecated: Use `schemaMetadata` Schema metadata of the dataset
externalUrl String	Deprecated: No longer supported Deprecated, use properties field instead External URL associated with the Dataset
origin FabricType!	Deprecated: No longer supported Deprecated, see the properties field instead Environment in which the dataset belongs to or where it was generated Note that this field will soon be deprecated in favor of a more standardized concept of Environment
description String	Deprecated: No longer supported Deprecated, use the properties field instead Read only technical description for dataset
platformNativeType PlatformNativeType	Deprecated: No longer supported Deprecated, do not use this field The logical type of the dataset ie table, stream, etc
uri String	Deprecated: No longer supported Deprecated, use properties instead Native Dataset Uri Uri should not include any environment specific properties
globalTags GlobalTags	Deprecated: No longer supported Deprecated, use tags field instead The structured tags associated with the dataset
subTypes SubTypes	Sub Types that this entity implements
viewProperties ViewProperties	View related properties. Only relevant if subtypes field contains view.
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
runs DataProcessInstanceResult	History of datajob runs that either produced or consumed this dataset Arguments Name Description start Int count Int direction RelationshipDirection!
siblings SiblingProperties	Metadata about the datasets siblings
fineGrainedLineages [FineGrainedLineage!]	Lineage information for the column-level. Includes a list of objects detailing which columns are upstream and which are downstream of each other. The upstream and downstream columns are from datasets.
privileges EntityPrivileges	Privileges given to a user relevant to this entity
exists Boolean	Whether or not this entity exists on DataHub
structuredProperties StructuredProperties	Structured properties about this Dataset
testResults TestResults	The results of evaluating tests

DatasetAssertionInfo

Detailed information about a Dataset Assertion

Fields

Name	Description
datasetUrn String!	The urn of the dataset that the assertion is related to
scope DatasetAssertionScope!	The scope of the Dataset assertion.
fields [SchemaFieldRef!]	The fields serving as input to the assertion. Empty if there are none.
aggregation AssertionStdAggregation	Standardized assertion operator
operator AssertionStdOperator!	Standardized assertion operator
parameters AssertionStdParameters	Standard parameters required for the assertion. e.g. min_value, max_value, value, columns
nativeType String	The native operator for the assertion. For Great Expectations, this will contain the original expectation name.
nativeParameters [StringMapEntry!]	Native parameters required for the assertion.
logic String	Logic comprising a raw, unstructured assertion.

DatasetDeprecation

Deprecated, use Deprecation instead Information about Dataset deprecation status Note that this model will soon be migrated to a more general purpose Entity status

Fields

Name	Description
deprecated Boolean!	Whether the dataset has been deprecated by owner
decommissionTime Long	The time user plan to decommission this dataset
note String!	Additional information about the dataset deprecation plan
actor String	The user who will be credited for modifying this deprecation content

DatasetEditableProperties

Dataset properties that are editable via the UI This represents logical metadata, as opposed to technical metadata

Fields

Name	Description
description String	Description of the Dataset

DatasetFieldProfile

An individual Dataset Field Profile

Fields

Name	Description
fieldPath String!	The standardized path of the field
uniqueCount Long	The unique value count for the field across the Dataset
uniqueProportion Float	The proportion of rows with unique values across the Dataset
nullCount Long	The number of NULL row values across the Dataset
nullProportion Float	The proportion of rows with NULL values across the Dataset
min String	The min value for the field
max String	The max value for the field
mean String	The mean value for the field
median String	The median value for the field
stdev String	The standard deviation for the field
sampleValues [String!]	A set of sample values for the field

DatasetFilter

Describes a generic filter on a dataset

Fields

Name	Description
type DatasetFilterType!	Type of partition
sql String	The raw query if using a SQL FilterType

DatasetProfile

A Dataset Profile associated with a Dataset, containing profiling statistics about the Dataset

Implements

• TimeSeriesAspect

Fields

Name	Description
timestampMillis Long!	The time at which the profile was reported
rowCount Long	An optional row count of the Dataset
columnCount Long	An optional column count of the Dataset
sizeInBytes Long	The storage size in bytes
fieldProfiles [DatasetFieldProfile!]	An optional set of per field statistics obtained in the profile
partitionSpec PartitionSpec	Information about the partition that was profiled

DatasetProperties

Additional read only properties about a Dataset

Fields

Name	Description
name String!	The name of the dataset used in display
qualifiedName String	Fully-qualified name of the Dataset
origin FabricType!	Environment in which the dataset belongs to or where it was generated Note that this field will soon be deprecated in favor of a more standardized concept of Environment
description String	Read only technical description for dataset
customProperties [CustomPropertiesEntry!]	Custom properties of the Dataset
externalUrl String	External URL associated with the Dataset
created Long	Created timestamp millis associated with the Dataset
createdActor String	Actor associated with the Dataset's created timestamp
lastModified AuditStamp!	Last Modified timestamp millis associated with the Dataset
lastModifiedActor String	Deprecated: No longer supported Actor associated with the Dataset's lastModified timestamp. Deprecated - Use lastModified.actor instead.

DatasetStatsSummary

Experimental - subject to change. A summary of usage metrics about a Dataset.

Fields

Name	Description
queryCountLast30Days Int	The query count in the past 30 days
uniqueUserCountLast30Days Int	The unique user count in the past 30 days
topUsersLast30Days [CorpUser!]	The top users in the past 30 days

DataTypeEntity

A data type registered in DataHub

Implements

• Entity

Fields

Name	Description
urn String!	A primary key associated with the Query
type EntityType!	A standard Entity Type
info DataTypeInfo!	Info about this type including its name
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!

DataTypeInfo

Properties about an individual data type

Fields

Name	Description
type StdDataType!	The standard data type
qualifiedName String!	The fully qualified name of the type. This includes its namespace
displayName String	The display name of this type
description String	The description of this type

DateRange

For consumption by UI only

Fields

Name	Description
start String!
end String!

DebugAccessResult

Experimental API result to debug Access for users. Backward incompatible changes will be made without notice in the future.

Fields

Name	Description
roles [String!]!	Roles that the user has.
groups [String!]!	Groups that the user belongs to.
groupsWithRoles [String!]!	List of groups that the user is assigned to AND where the group has a role. This is a subset of the groups property.
rolesViaGroups [String!]!	Final set of roles that are coming through groups. If not role assigned to groups, then this would be empty.
allRoles [String!]!	Union of roles + rolesViaGroups that the user has.
policies [String!]!	List of Policy that apply to this user directly or indirectly.
privileges [String!]!	List of privileges that this user has directly or indirectly.

Deprecation

Information about Metadata Entity deprecation status

Fields

Name	Description
deprecated Boolean!	Whether the entity has been deprecated by owner
decommissionTime Long	The time user plan to decommission this entity
note String	Additional information about the entity deprecation plan
actor String	The user who will be credited for modifying this deprecation content

Domain

A domain, or a logical grouping of Metadata Entities

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the domain
type EntityType!	A standard Entity Type
id String!	Id of the domain
properties DomainProperties	Properties about a domain
ownership Ownership	Ownership metadata of the dataset
institutionalMemory InstitutionalMemory	References to internal resources related to the dataset
entities SearchResults	Children entities inside of the Domain Arguments Name Description input DomainEntitiesInput
parentDomains ParentDomainsResult	Recursively get the lineage of parent domains for this entity
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

DomainAssociation

Fields

Name	Description
domain Domain!	The domain related to the assocaited urn
associatedUrn String!	Reference back to the tagged urn for tracking purposes e.g. when sibling nodes are merged together

DomainProperties

Properties about a domain

Fields

Name	Description
name String!	Display name of the domain
description String	Description of the Domain

DownstreamEntityRelationships

Deprecated, use relationships query instead

Fields

Name	Description
entities [EntityRelationshipLegacy]

EditableSchemaFieldInfo

Editable schema field metadata ie descriptions, tags, etc

Fields

Name	Description
fieldPath String!	Flattened name of a field identifying the field the editable info is applied to
description String	Edited description of the field
globalTags GlobalTags	Deprecated: No longer supported Deprecated, use tags field instead Tags associated with the field
tags GlobalTags	Tags associated with the field
glossaryTerms GlossaryTerms	Glossary terms associated with the field

EditableSchemaMetadata

Information about schema metadata that is editable via the UI

Fields

Name	Description
editableSchemaFieldInfo [EditableSchemaFieldInfo!]!	Editable schema field metadata

EditableTagProperties

Additional read write Tag properties Deprecated! Replaced by TagProperties.

Fields

Name	Description
name String	A display name for the Tag
description String	A description of the Tag

Embed

Information required to render an embedded version of an asset

Fields

Name	Description
renderUrl String	A URL which can be rendered inside of an iframe.

EntityAssertionsResult

A list of Assertions Associated with an Entity

Fields

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of assertions in the returned result set
total Int!	The total number of assertions in the result set
assertions [Assertion!]!	The assertions themselves

EntityCountResult

Fields

Name	Description
entityType EntityType!
count Int!

EntityCountResults

Fields

Name	Description
counts [EntityCountResult!]

EntityLineageResult

A list of lineage information associated with a source Entity

Fields

Name	Description
start Int	Start offset of the result set
count Int	Number of results in the returned result set
total Int	Total number of results in the result set
filtered Int	The number of results that were filtered out of the page (soft-deleted or non-existent)
relationships [LineageRelationship!]!	Relationships in the result set

EntityPath

An overview of the field that was matched in the entity search document

Fields

Name	Description
path [Entity]	Path of entities between source and destination nodes

EntityPrivileges

Shared privileges object across entities. Not all privileges apply to every entity.

Fields

Name	Description
canManageChildren Boolean	Whether or not a user can create child entities under a parent entity. For example, can one create Terms/Node sunder a Glossary Node.
canManageEntity Boolean	Whether or not a user can delete or move this entity.
canEditLineage Boolean	Whether or not a user can create or delete lineage edges for an entity.
canEditEmbed Boolean	Whether or not a user update the embed information
canEditQueries Boolean	Whether or not a user can update the Queries for the entity (e.g. dataset)
canEditProperties Boolean	Whether or not a user can update the properties for the entity (e.g. dataset)

EntityProfileConfig

Configuration for an entity profile

Fields

Name	Description
defaultTab String	The enum value from EntityProfileTab for which tab should be showed by default on entity profile pages. If null, rely on default sorting from React code.

EntityProfileParams

Context to define the entity profile page

Fields

Name	Description
urn String!	Urn of the entity being shown
type EntityType!	Type of the enity being displayed

EntityProfilesConfig

Configuration for different entity profiles

Fields

Name	Description
domain EntityProfileConfig	The configurations for a Domain entity profile

EntityRelationship

A relationship between two entities TODO Migrate all entity relationships to this more generic model

Fields

Name	Description
type String!	The type of the relationship
direction RelationshipDirection!	The direction of the relationship relative to the source entity
entity Entity	Entity that is related via lineage
created AuditStamp	An AuditStamp corresponding to the last modification of this relationship

EntityRelationshipLegacy

Deprecated, use relationships query instead

Fields

Name	Description
entity EntityWithRelationships	Entity that is related via lineage
created AuditStamp	An AuditStamp corresponding to the last modification of this relationship

EntityRelationshipsResult

A list of relationship information associated with a source Entity

Fields

Name	Description
start Int	Start offset of the result set
count Int	Number of results in the returned result set
total Int	Total number of results in the result set
relationships [EntityRelationship!]!	Relationships in the result set

EntityTypeEntity

An entity type registered in DataHub

Implements

• Entity

Fields

Name	Description
urn String!	A primary key associated with the Query
type EntityType!	A standard Entity Type
info EntityTypeInfo!	Info about this type including its name
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!

EntityTypeInfo

Properties about an individual entity type

Fields

Name	Description
type EntityType!	The standard entity type
qualifiedName String!	The fully qualified name of the entity type. This includes its namespace
displayName String	The display name of this type
description String	The description of this type

ERModelRelationship

An ERModelRelationship is a high-level abstraction that dictates what datasets fields are erModelRelationshiped.

Implements

• EntityWithRelationships
• Entity

Fields

Name	Description
urn String!	The primary key of the role
type EntityType!	The standard Entity Type
id String!	Unique id for the erModelRelationship
properties ERModelRelationshipProperties	An additional set of read only properties
editableProperties ERModelRelationshipEditableProperties	An additional set of of read write properties
institutionalMemory InstitutionalMemory	References to internal resources related to the dataset
ownership Ownership	Ownership metadata of the dataset
status Status	Status of the Dataset
tags GlobalTags	Tags used for searching dataset
glossaryTerms GlossaryTerms	The structured glossary terms associated with the dataset
relationships EntityRelationshipsResult	List of relationships between the source Entity and some destination entities with a given types Arguments Name Description input RelationshipsInput!
privileges EntityPrivileges	Privileges given to a user relevant to this entity
lineage EntityLineageResult	No-op required for the model Arguments Name Description input LineageInput!

ERModelRelationshipEditableProperties

Additional properties about a ERModelRelationship

Fields

Name	Description
description String	Documentation of the ERModelRelationship
name String	Display name of the ERModelRelationship

ERModelRelationshipProperties

Additional properties about a ERModelRelationship

Fields

Name	Description
name String!	The name of the ERModelRelationship used in display
source Dataset!	The urn of source
destination Dataset!	The urn of destination
relationshipFieldMappings [RelationshipFieldMapping!]	The relationFieldMappings
createdTime Long	Created timestamp millis associated with the ERModelRelationship
createdActor Entity	Created actor urn associated with the ERModelRelationship

EthicalConsiderations

Fields

Name	Description
data [String!]	Does the model use any sensitive data eg, protected classes
humanLife [String!]	Is the model intended to inform decisions about matters central to human life or flourishing eg, health or safety
mitigations [String!]	What risk mitigation strategies were used during model development
risksAndHarms [String!]	What risks may be present in model usage Try to identify the potential recipients, likelihood, and magnitude of harms If these cannot be determined, note that they were considered but remain unknown
useCases [String!]	Are there any known model use cases that are especially fraught This may connect directly to the intended use section

ExecutionRequest

Retrieve an ingestion execution request

Fields

Name	Description
urn String!	Urn of the execution request
id String!	Unique id for the execution request
input ExecutionRequestInput!	Input provided when creating the Execution Request
result ExecutionRequestResult	Result of the execution request

ExecutionRequestInput

Input provided when creating an Execution Request

Fields

Name	Description
task String!	The type of the task to executed
source ExecutionRequestSource!	The source of the execution request
arguments [StringMapEntry!]	Arguments provided when creating the execution request
requestedAt Long!	The time at which the request was created
actorUrn String	Urn of the actor who created this execution request

ExecutionRequestResult

The result of an ExecutionRequest

Fields

Name	Description
status String!	The result of the request, e.g. either SUCCEEDED or FAILED
startTimeMs Long	Time at which the task began
durationMs Long	Duration of the task
report String	A report about the ingestion run
structuredReport StructuredReport	A structured report for this Execution Request

ExecutionRequestSource

Information about the source of an execution request

Fields

Name	Description
type String	The type of the source, e.g. SCHEDULED_INGESTION_SOURCE

FacetFilter

A single filter value

Fields

Name	Description
field String!	Name of field to filter by
condition FilterOperator	Condition for the values.
values [String!]!	Values, one of which the intended field should match.
negated Boolean	If the filter should or should not be matched

FacetMetadata

Contains valid fields to filter search results further on

Fields

Name	Description
field String!	Name of a field present in the search entity
displayName String	Display name of the field
aggregations [AggregationMetadata!]!	Aggregated search result counts by value of the field

FeatureFlagsConfig

Configurations related to DataHub Views feature

Fields

Name	Description
readOnlyModeEnabled Boolean!	Whether read only mode is enabled on an instance. Right now this only affects ability to edit user profile image URL but can be extended.
showSearchFiltersV2 Boolean!	Whether search filters V2 should be shown or the default filter side-panel
showBrowseV2 Boolean!	Whether browse V2 sidebar should be shown
platformBrowseV2 Boolean!	Whether browse v2 is platform mode, which means that platforms are displayed instead of entity types at the root.
showAcrylInfo Boolean!	Whether we should show CTAs in the UI related to moving to Managed DataHub by Acryl.
erModelRelationshipFeatureEnabled Boolean!	Whether ERModelRelationship Tables Feature should be shown.
showAccessManagement Boolean!	Whether we should show AccessManagement tab in the datahub UI.
nestedDomainsEnabled Boolean!	Enables the nested Domains feature that allows users to have sub-Domains. If this is off, Domains appear "flat" again.
businessAttributeEntityEnabled Boolean!	Whether business attribute entity should be shown

FieldFormPromptAssociation

An association for field-level form prompts

Fields

Name	Description
fieldPath String!	The schema field path
lastModified ResolvedAuditStamp!	When and by whom this form field-level prompt has last been modified

FieldUsageCounts

The usage for a particular Dataset field

Fields

Name	Description
fieldName String	The path of the field
count Int	The count of usages

FineGrainedLineage

Fields

Name	Description
upstreams [SchemaFieldRef!]
downstreams [SchemaFieldRef!]
query String
transformOperation String

FloatBox

Fields

Name	Description
floatValue Float!

ForeignKeyConstraint

Metadata around a foreign key constraint between two datasets

Fields

Name	Description
name String	The human-readable name of the constraint
foreignFields [SchemaFieldEntity]	List of fields in the foreign dataset
sourceFields [SchemaFieldEntity]	List of fields in this dataset
foreignDataset Dataset	The foreign dataset for easy reference

Form

A form that helps with filling out metadata on an entity

Implements

• Entity

Fields

Name	Description
urn String!	A primary key associated with the Form
type EntityType!	A standard Entity Type
info FormInfo!	Information about this form
ownership Ownership	Ownership metadata of the form
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!

FormActorAssignment

Fields

Name	Description
owners Boolean!	Whether the form should be completed by owners of the assets which the form is applied to.
users [CorpUser!]	Urns of the users that the form is assigned to. If null, then no users are specifically targeted.
groups [CorpGroup!]	Groups that the form is assigned to. If null, then no groups are specifically targeted.
isAssignedToMe Boolean!	Whether or not the current actor is universally assigned to this form, either by user or by group. Note that this does not take into account entity ownership based assignment.

FormAssociation

Fields

Name	Description
form Form!	The form related to the associated urn
associatedUrn String!	Reference back to the urn with the form on it for tracking purposes e.g. when sibling nodes are merged together
incompletePrompts [FormPromptAssociation!]	The prompt that still need to be completed for this form
completedPrompts [FormPromptAssociation!]	The prompt that are already completed for this form

FormInfo

Properties about an individual Form

Fields

Name	Description
name String!	The name of this form
description String	The description of this form
type FormType!	The type of this form
prompts [FormPrompt!]!	The prompt for this form
actors FormActorAssignment!	The actors that are assigned to complete the forms for the associated entities.

FormPrompt

A prompt shown to the user to collect metadata about an entity

Fields

Name	Description
id String!	The ID of this prompt. This will be globally unique.
title String!	The title of this prompt
formUrn String!	The urn of the parent form that this prompt is part of
description String	The description of this prompt
type FormPromptType!	The description of this prompt
required Boolean!	Whether the prompt is required for the form to be considered completed.
structuredPropertyParams StructuredPropertyParams	The params for this prompt if type is STRUCTURED_PROPERTY

FormPromptAssociation

A form that helps with filling out metadata on an entity

Fields

Name	Description
id String!	The unique id of the form prompt
lastModified ResolvedAuditStamp!	When and by whom this form prompt has last been modified
fieldAssociations FormPromptFieldAssociations	Optional information about the field-level prompt associations.

FormPromptFieldAssociations

Information about the field-level prompt associations.

Fields

Name	Description
completedFieldPrompts [FieldFormPromptAssociation!]	If this form prompt is for fields, this will contain a list of completed associations per field
incompleteFieldPrompts [FieldFormPromptAssociation!]	If this form prompt is for fields, this will contain a list of incomlete associations per field

Forms

Requirements forms that are assigned to an entity.

Fields

Name	Description
incompleteForms [FormAssociation!]!	Forms that are still incomplete.
completedForms [FormAssociation!]!	Forms that have been completed.
verifications [FormVerificationAssociation!]!	Verifications that have been applied to the entity via completed forms.

FormVerificationAssociation

Verification object that has been applied to the entity via a completed form.

Fields

Name	Description
form Form!	The form related to the associated urn
lastModified ResolvedAuditStamp	When this verification was applied to this entity

FreshnessStats

Freshness stats for a query result. Captures whether the query was served out of a cache, what the staleness was, etc.

Fields

Name	Description
cached Boolean	Whether a cache was used to respond to this query
systemFreshness [SystemFreshness]	The latest timestamp in millis of the system that was used to respond to this query In case a cache was consulted, this reflects the freshness of the cache In case an index was consulted, this reflects the freshness of the index

GetQuickFiltersResult

The result object when fetching quick filters

Fields

Name	Description
quickFilters [QuickFilter]!	The list of quick filters to render in the UI

GetRootGlossaryNodesResult

The result when getting Glossary entities

Fields

Name	Description
nodes [GlossaryNode!]!	A list of Glossary Nodes without a parent node
start Int!	The starting offset of the result set returned
count Int!	The number of nodes in the returned result
total Int!	The total number of nodes in the result set

GetRootGlossaryTermsResult

The result when getting root GlossaryTerms

Fields

Name	Description
terms [GlossaryTerm!]!	A list of Glossary Terms without a parent node
start Int!	The starting offset of the result set returned
count Int!	The number of terms in the returned result
total Int!	The total number of terms in the result set

GetSchemaBlameResult

Schema changes computed at a specific version.

Fields

Name	Description
version SemanticVersionStruct	Selected semantic version
schemaFieldBlameList [SchemaFieldBlame!]	List of schema blame. Absent when there are no fields to return history for.

GetSchemaVersionListResult

Schema changes computed at a specific version.

Fields

Name	Description
latestVersion SemanticVersionStruct	Latest and current semantic version
version SemanticVersionStruct	Selected semantic version
semanticVersionList [SemanticVersionStruct!]	All semantic versions. Absent when there are no versions.

GlobalTags

Tags attached to a particular Metadata Entity

Fields

Name	Description
tags [TagAssociation!]	The set of tags attached to the Metadata Entity

GlobalViewsSettings

Global (platform-level) settings related to the Views feature

Fields

Name	Description
defaultView String	The global default View. If a user does not have a personal default, then this will be the default view.

GlossaryNode

A Glossary Node, or a directory in a Business Glossary represents a container of Glossary Terms or other Glossary Nodes

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the glossary term
ownership Ownership	Ownership metadata of the glossary term
type EntityType!	A standard Entity Type
properties GlossaryNodeProperties	Additional properties associated with the Glossary Term
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!
parentNodes ParentNodesResult	Recursively get the lineage of glossary nodes for this entity
privileges EntityPrivileges	Privileges given to a user relevant to this entity
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset

GlossaryNodeProperties

Additional read only properties about a Glossary Node

Fields

Name	Description
name String!	The name of the Glossary Term
description String	Description of the glossary term
customProperties [CustomPropertiesEntry!]	Custom properties of the Glossary Node

GlossaryTerm

A Glossary Term, or a node in a Business Glossary representing a standardized domain data type

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the glossary term
ownership Ownership	Ownership metadata of the glossary term
domain DomainAssociation	The Domain associated with the glossary term
institutionalMemory InstitutionalMemory	References to internal resources related to the Glossary Term
type EntityType!	A standard Entity Type
name String!	Deprecated: No longer supported A unique identifier for the Glossary Term. Deprecated - Use properties.name field instead.
hierarchicalName String!	hierarchicalName of glossary term
properties GlossaryTermProperties	Additional properties associated with the Glossary Term
glossaryTermInfo GlossaryTermInfo	Deprecated, use properties field instead Details of the Glossary Term
deprecation Deprecation	The deprecation status of the Glossary Term
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!
schemaMetadata SchemaMetadata	Schema metadata of the dataset Arguments Name Description version Long
parentNodes ParentNodesResult	Recursively get the lineage of glossary nodes for this entity
privileges EntityPrivileges	Privileges given to a user relevant to this entity
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset

GlossaryTermAssociation

An edge between a Metadata Entity and a Glossary Term Modeled as a struct to permit additional attributes TODO Consider whether this query should be serviced by the relationships field

Fields

Name	Description
term GlossaryTerm!	The glossary term itself
actor CorpUser	The actor who is responsible for the term being added"
associatedUrn String!	Reference back to the associated urn for tracking purposes e.g. when sibling nodes are merged together

GlossaryTermInfo

Deprecated, use GlossaryTermProperties instead Information about a glossary term

Fields

Name	Description
name String	The name of the Glossary Term
description String	Description of the glossary term
definition String!	Deprecated: No longer supported Definition of the glossary term. Deprecated - Use 'description' instead.
termSource String!	Term Source of the glossary term
sourceRef String	Source Ref of the glossary term
sourceUrl String	Source Url of the glossary term
customProperties [CustomPropertiesEntry!]	Properties of the glossary term
rawSchema String	Schema definition of glossary term

GlossaryTermProperties

Additional read only properties about a Glossary Term

Fields

Name	Description
name String!	The name of the Glossary Term
description String	Description of the glossary term
definition String!	Deprecated: No longer supported Definition of the glossary term. Deprecated - Use 'description' instead.
termSource String!	Term Source of the glossary term
sourceRef String	Source Ref of the glossary term
sourceUrl String	Source Url of the glossary term
customProperties [CustomPropertiesEntry!]	Properties of the glossary term
rawSchema String	Schema definition of glossary term

GlossaryTerms

Glossary Terms attached to a particular Metadata Entity

Fields

Name	Description
terms [GlossaryTermAssociation!]	The set of glossary terms attached to the Metadata Entity

Health

The resolved Health of an Asset

Fields

Name	Description
type HealthStatusType!	An enum representing the type of health indicator
status HealthStatus!	An enum representing the resolved Health status of an Asset
message String	An optional message describing the resolved health status
causes [String!]	The causes responsible for the health status

Highlight

For consumption by UI only

Fields

Name	Description
value Int!
title String!
body String!

HyperParameterMap

Fields

Name	Description
key String!
value HyperParameterValueType!

IdentityManagementConfig

Configurations related to Identity Management

Fields

Name	Description
enabled Boolean!	Whether identity management screen is able to be shown in the UI

IngestionConfig

A set of configurations for an Ingestion Source

Fields

Name	Description
recipe String!	The JSON-encoded recipe to use for ingestion
executorId String!	Advanced: The specific executor that should handle the execution request. Defaults to 'default'.
version String	Advanced: The version of the ingestion framework to use
debugMode Boolean	Advanced: Whether or not to run ingestion in debug mode
extraArgs [StringMapEntry!]	Advanced: Extra arguments for the ingestion run.

IngestionRun

The runs associated with an Ingestion Source managed by DataHub

Fields

Name	Description
executionRequestUrn String	The urn of the execution request associated with the user

IngestionSchedule

A schedule associated with an Ingestion Source

Fields

Name	Description
timezone String	Time Zone abbreviation (e.g. GMT, EDT). Defaults to UTC.
interval String!	The cron-formatted interval to execute the ingestion source on

IngestionSource

An Ingestion Source Entity

Fields

Name	Description
urn String!	The primary key of the Ingestion Source
type String!	The type of the source itself, e.g. mysql, bigquery, bigquery-usage. Should match the recipe.
name String!	The display name of the Ingestion Source
schedule IngestionSchedule	An optional schedule associated with the Ingestion Source
platform DataPlatform	The data platform associated with this ingestion source
config IngestionConfig!	An type-specific set of configurations for the ingestion source
executions IngestionSourceExecutionRequests	Previous requests to execute the ingestion source Arguments Name Description start Int count Int

IngestionSourceExecutionRequests

Requests for execution associated with an ingestion source

Fields

Name	Description
start Int	The starting offset of the result set
count Int	The number of results to be returned
total Int	The total number of results in the result set
executionRequests [ExecutionRequest!]!	The execution request objects comprising the result set

InputField

Input field of the chart

Fields

Name	Description
schemaFieldUrn String
schemaField SchemaField

InputFields

Input fields of the chart

Fields

Name	Description
fields [InputField]

InstitutionalMemory

Institutional memory metadata, meaning internal links and pointers related to an Entity

Fields

Name	Description
elements [InstitutionalMemoryMetadata!]!	List of records that represent the institutional memory or internal documentation of an entity

InstitutionalMemoryMetadata

An institutional memory resource about a particular Metadata Entity

Fields

Name	Description
url String!	Link to a document or wiki page or another internal resource
label String!	Label associated with the URL
author CorpUser!	The author of this metadata
created AuditStamp!	An AuditStamp corresponding to the creation of this resource
description String!	Deprecated: No longer supported Deprecated, use label instead Description of the resource
associatedUrn String!	Reference back to the owned urn for tracking purposes e.g. when sibling nodes are merged together

IntBox

Fields

Name	Description
intValue Int!

IntendedUse

Fields

Name	Description
primaryUses [String!]	Primary Use cases for the model
primaryUsers [IntendedUserType!]	Primary Intended Users
outOfScopeUses [String!]	Out of scope uses of the MLModel

InviteToken

Token that allows users to sign up as a native user

Fields

Name	Description
inviteToken String!	The invite token

KeyValueSchema

Information about a raw Key Value Schema

Fields

Name	Description
keySchema String!	Raw key schema
valueSchema String!	Raw value schema

LineageConfig

Configurations related to Lineage

Fields

Name	Description
supportsImpactAnalysis Boolean!	Whether the backend support impact analysis feature

LineageRelationship

Metadata about a lineage relationship between two entities

Fields

Name	Description
type String!	The type of the relationship
entity Entity	Entity that is related via lineage
degree Int!	Degree of relationship (number of hops to get to entity)
createdOn Long	Timestamp for when this lineage relationship was created. Could be null.
createdActor Entity	The actor who created this lineage relationship. Could be null.
updatedOn Long	Timestamp for when this lineage relationship was last updated. Could be null.
updatedActor Entity	The actor who last updated this lineage relationship. Could be null.
isManual Boolean	Whether this edge is a manual edge. Could be null.
paths [EntityPath]	The paths traversed for this relationship

LinkParams

Parameters required to specify the page to land once clicked

Fields

Name	Description
searchParams SearchParams	Context to define the search page
entityProfileParams EntityProfileParams	Context to define the entity profile page

ListAccessTokenResult

Results returned when listing access tokens

Fields

Name	Description
start Int!	The starting offset of the result set
count Int!	The number of results to be returned
total Int!	The total number of results in the result set
tokens [AccessTokenMetadata!]!	The token metadata themselves

ListBusinessAttributesResult

The result obtained when listing Business Attribute

Fields

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of Business Attributes in the returned result set
total Int!	The total number of Business Attributes in the result set
businessAttributes [BusinessAttribute!]!	The Business Attributes

ListDomainsResult

The result obtained when listing DataHub Domains

Fields

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of Domains in the returned result set
total Int!	The total number of Domains in the result set
domains [Domain!]!	The Domains themselves

ListGroupsResult

The result obtained when listing DataHub Groups

Fields

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of Policies in the returned result set
total Int!	The total number of Policies in the result set
groups [CorpGroup!]!	The groups themselves

ListIngestionSourcesResult

Results returned when listing ingestion sources

Fields

Name	Description
start Int!	The starting offset of the result set
count Int!	The number of results to be returned
total Int!	The total number of results in the result set
ingestionSources [IngestionSource!]!	The Ingestion Sources themselves

ListOwnershipTypesResult

Results when listing custom ownership types.

Fields

Name	Description
start Int!	The starting offset of the result set
count Int!	The number of results to be returned
total Int!	The total number of results in the result set
ownershipTypes [OwnershipTypeEntity!]!	The Custom Ownership Types themselves

ListPoliciesResult

The result obtained when listing DataHub Access Policies

Fields

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of Policies in the returned result set
total Int!	The total number of Policies in the result set
policies [Policy!]!	The Policies themselves

ListPostsResult

The result obtained when listing Posts

Fields

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of Roles in the returned result set
total Int!	The total number of Roles in the result set
posts [Post!]!	The Posts themselves

ListQueriesResult

Results when listing entity queries

Fields

Name	Description
start Int!	The starting offset of the result set
count Int!	The number of results to be returned
total Int!	The total number of results in the result set
queries [QueryEntity!]!	The Queries themselves

ListRecommendationsResult

Results returned by the ListRecommendations query

Fields

Name	Description
modules [RecommendationModule!]!	List of modules to show

ListRolesResult

The result obtained when listing DataHub Roles

Fields

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of Roles in the returned result set
total Int!	The total number of Roles in the result set
roles [DataHubRole!]!	The Roles themselves

ListSecretsResult

Input for listing DataHub Secrets

Fields

Name	Description
start Int	The starting offset of the result set
count Int	The number of results to be returned
total Int	The total number of results in the result set
secrets [Secret!]!	The secrets themselves

ListTestsResult

The result obtained when listing DataHub Tests

Fields

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of Tests in the returned result set
total Int!	The total number of Tests in the result set
tests [Test!]!	The Tests themselves

ListUsersResult

The result obtained when listing DataHub Users

Fields

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of Policies in the returned result set
total Int!	The total number of Policies in the result set
users [CorpUser!]!	The users themselves

ListViewsResult

The result obtained when listing DataHub Views

Fields

Name	Description
start Int!	The starting offset of the result set returned
count Int!	The number of Views in the returned result set
total Int!	The total number of Views in the result set
views [DataHubView!]!	The Views themselves

ManagedIngestionConfig

Configurations related to managed, UI based ingestion

Fields

Name	Description
enabled Boolean!	Whether ingestion screen is enabled in the UI

MatchedField

An overview of the field that was matched in the entity search document

Fields

Name	Description
name String!	Name of the field that matched
value String!	Value of the field that matched
entity Entity	Entity if the value is an urn

Media

Media content

Fields

Name	Description
type MediaType!	The type of media
location String!	The location of the media (a URL)

Metrics

Fields

Name	Description
performanceMeasures [String!]	Measures of ML Model performance
decisionThreshold [String!]	Decision Thresholds used if any

MLFeature

An ML Feature Metadata Entity Note that this entity is incubating

Implements

• EntityWithRelationships
• Entity

Fields

Name	Description
urn String!	The primary key of the ML Feature
type EntityType!	A standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
name String!	The display name for the ML Feature
featureNamespace String!	MLFeature featureNamespace
description String	The description about the ML Feature
dataType MLFeatureDataType	MLFeature data type
ownership Ownership	Ownership metadata of the MLFeature
featureProperties MLFeatureProperties	Deprecated: No longer supported ModelProperties metadata of the MLFeature
properties MLFeatureProperties	ModelProperties metadata of the MLFeature
institutionalMemory InstitutionalMemory	References to internal resources related to the MLFeature
status Status	Status metadata of the MLFeature
deprecation Deprecation	Deprecation
browsePathV2 BrowsePathV2	The browse path V2 corresponding to an entity. If no Browse Paths V2 have been generated before, this will be null.
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
tags GlobalTags	Tags applied to entity
glossaryTerms GlossaryTerms	The structured glossary terms associated with the entity
domain DomainAssociation	The Domain associated with the entity
editableProperties MLFeatureEditableProperties	An additional set of of read write properties
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

MLFeatureEditableProperties

Fields

Name	Description
description String	The edited description

MLFeatureProperties

Fields

Name	Description
description String
dataType MLFeatureDataType
version VersionTag
sources [Dataset]

MLFeatureTable

An ML Feature Table Entity Note that this entity is incubating

Implements

• EntityWithRelationships
• Entity
• BrowsableEntity

Fields

Name	Description
urn String!	The primary key of the ML Feature Table
type EntityType!	A standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
name String!	The display name
platform DataPlatform!	Standardized platform urn where the MLFeatureTable is defined
description String	MLFeatureTable description
ownership Ownership	Ownership metadata of the MLFeatureTable
properties MLFeatureTableProperties	Additional read only properties associated the the ML Feature Table
featureTableProperties MLFeatureTableProperties	Deprecated: No longer supported Deprecated, use properties field instead ModelProperties metadata of the MLFeature
institutionalMemory InstitutionalMemory	References to internal resources related to the MLFeature
status Status	Status metadata of the MLFeatureTable
deprecation Deprecation	Deprecation
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
browsePaths [BrowsePath!]	The browse paths corresponding to the ML Feature Table. If no Browse Paths have been generated before, this will be null.
browsePathV2 BrowsePathV2	The browse path V2 corresponding to an entity. If no Browse Paths V2 have been generated before, this will be null.
tags GlobalTags	Tags applied to entity
glossaryTerms GlossaryTerms	The structured glossary terms associated with the entity
domain DomainAssociation	The Domain associated with the entity
editableProperties MLFeatureTableEditableProperties	An additional set of of read write properties
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

MLFeatureTableEditableProperties

Fields

Name	Description
description String	The edited description

MLFeatureTableProperties

Fields

Name	Description
description String
mlFeatures [MLFeature]
mlPrimaryKeys [MLPrimaryKey]
customProperties [CustomPropertiesEntry!]

MLHyperParam

Fields

Name	Description
name String
description String
value String
createdAt Long

MLMetric

Fields

Name	Description
name String
description String
value String
createdAt Long

MLModel

An ML Model Metadata Entity Note that this entity is incubating

Implements

• EntityWithRelationships
• Entity
• BrowsableEntity

Fields

Name	Description
urn String!	The primary key of the ML model
type EntityType!	A standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
name String!	ML model display name
platform DataPlatform!	Standardized platform urn where the MLModel is defined
origin FabricType!	Fabric type where mlmodel belongs to or where it was generated
description String	Human readable description for mlmodel
globalTags GlobalTags	Deprecated: No longer supported Deprecated, use tags field instead The standard tags for the ML Model
tags GlobalTags	The standard tags for the ML Model
ownership Ownership	Ownership metadata of the mlmodel
properties MLModelProperties	Additional read only information about the ML Model
intendedUse IntendedUse	Intended use of the mlmodel
factorPrompts MLModelFactorPrompts	Factors metadata of the mlmodel
metrics Metrics	Metrics metadata of the mlmodel
evaluationData [BaseData!]	Evaluation Data of the mlmodel
trainingData [BaseData!]	Training Data of the mlmodel
quantitativeAnalyses QuantitativeAnalyses	Quantitative Analyses of the mlmodel
ethicalConsiderations EthicalConsiderations	Ethical Considerations of the mlmodel
caveatsAndRecommendations CaveatsAndRecommendations	Caveats and Recommendations of the mlmodel
institutionalMemory InstitutionalMemory	References to internal resources related to the mlmodel
sourceCode SourceCode	Source Code
status Status	Status metadata of the mlmodel
cost Cost	Cost Aspect of the mlmodel
deprecation Deprecation	Deprecation
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
browsePaths [BrowsePath!]	The browse paths corresponding to the ML Model. If no Browse Paths have been generated before, this will be null.
browsePathV2 BrowsePathV2	The browse path V2 corresponding to an entity. If no Browse Paths V2 have been generated before, this will be null.
glossaryTerms GlossaryTerms	The structured glossary terms associated with the entity
domain DomainAssociation	The Domain associated with the entity
editableProperties MLModelEditableProperties	An additional set of of read write properties
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

MLModelEditableProperties

Fields

Name	Description
description String	The edited description

MLModelFactorPrompts

Fields

Name	Description
relevantFactors [MLModelFactors!]	What are foreseeable salient factors for which MLModel performance may vary, and how were these determined
evaluationFactors [MLModelFactors!]	Which factors are being reported, and why were these chosen

MLModelFactors

Fields

Name	Description
groups [String!]	Distinct categories with similar characteristics that are present in the evaluation data instances
instrumentation [String!]	Instrumentation used for MLModel
environment [String!]	Environment in which the MLModel is deployed

MLModelGroup

An ML Model Group Metadata Entity Note that this entity is incubating

Implements

• EntityWithRelationships
• Entity
• BrowsableEntity

Fields

Name	Description
urn String!	The primary key of the ML Model Group
type EntityType!	A standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
name String!	The display name for the Entity
platform DataPlatform!	Standardized platform urn where the MLModelGroup is defined
origin FabricType!	Fabric type where MLModelGroup belongs to or where it was generated
description String	Human readable description for MLModelGroup
properties MLModelGroupProperties	Additional read only properties about the ML Model Group
ownership Ownership	Ownership metadata of the MLModelGroup
status Status	Status metadata of the MLModelGroup
deprecation Deprecation	Deprecation
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
browsePaths [BrowsePath!]	The browse paths corresponding to the ML Model Group. If no Browse Paths have been generated before, this will be null.
browsePathV2 BrowsePathV2	The browse path V2 corresponding to an entity. If no Browse Paths V2 have been generated before, this will be null.
tags GlobalTags	Tags applied to entity
glossaryTerms GlossaryTerms	The structured glossary terms associated with the entity
domain DomainAssociation	The Domain associated with the entity
editableProperties MLModelGroupEditableProperties	An additional set of of read write properties
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

MLModelGroupEditableProperties

Fields

Name	Description
description String	The edited description

MLModelGroupProperties

Fields

Name	Description
description String
createdAt Long
version VersionTag

MLModelProperties

Fields

Name	Description
description String
date Long
version String
type String
hyperParameters HyperParameterMap
hyperParams [MLHyperParam]
trainingMetrics [MLMetric]
mlFeatures [String!]
tags [String!]
groups [MLModelGroup]
customProperties [CustomPropertiesEntry!]
externalUrl String

MLPrimaryKey

An ML Primary Key Entity Note that this entity is incubating

Implements

• EntityWithRelationships
• Entity

Fields

Name	Description
urn String!	The primary key of the ML Primary Key
type EntityType!	A standard Entity Type
lastIngested Long	The timestamp for the last time this entity was ingested
name String!	The display name
featureNamespace String!	MLPrimaryKey featureNamespace
description String	MLPrimaryKey description
dataType MLFeatureDataType	MLPrimaryKey data type
properties MLPrimaryKeyProperties	Additional read only properties of the ML Primary Key
primaryKeyProperties MLPrimaryKeyProperties	Deprecated: No longer supported Deprecated, use properties field instead MLPrimaryKeyProperties
ownership Ownership	Ownership metadata of the MLPrimaryKey
institutionalMemory InstitutionalMemory	References to internal resources related to the MLPrimaryKey
status Status	Status metadata of the MLPrimaryKey
deprecation Deprecation	Deprecation
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!
tags GlobalTags	Tags applied to entity
glossaryTerms GlossaryTerms	The structured glossary terms associated with the entity
domain DomainAssociation	The Domain associated with the entity
editableProperties MLPrimaryKeyEditableProperties	An additional set of of read write properties
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams
structuredProperties StructuredProperties	Structured properties about this asset
forms Forms	The forms associated with the Dataset
privileges EntityPrivileges	Privileges given to a user relevant to this entity

MLPrimaryKeyEditableProperties

Fields

Name	Description
description String	The edited description

MLPrimaryKeyProperties

Fields

Name	Description
description String
dataType MLFeatureDataType
version VersionTag
sources [Dataset]

NamedBar

For consumption by UI only

Fields

Name	Description
name String!
segments [BarSegment!]!

NamedLine

For consumption by UI only

Fields

Name	Description
name String!
data [NumericDataPoint!]!

Notebook

A Notebook Metadata Entity

Implements

• Entity
• BrowsableEntity

Fields

Name	Description
urn String!	The primary key of the Notebook
type EntityType!	A standard Entity Type
tool String!	The Notebook tool name
notebookId String!	An id unique within the Notebook tool
info NotebookInfo	Additional read only information about the Notebook
editableProperties NotebookEditableProperties	Additional read write properties about the Notebook
ownership Ownership	Ownership metadata of the Notebook
status Status	Status metadata of the Notebook
content NotebookContent!	The content of this Notebook
tags GlobalTags	The tags associated with the Notebook
institutionalMemory InstitutionalMemory	References to internal resources related to the Notebook
domain DomainAssociation	The Domain associated with the Notebook
dataPlatformInstance DataPlatformInstance	The specific instance of the data platform that this entity belongs to
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!
subTypes SubTypes	Sub Types that this entity implements
glossaryTerms GlossaryTerms	The structured glossary terms associated with the notebook
platform DataPlatform!	Standardized platform.
browsePaths [BrowsePath!]	The browse paths corresponding to the Notebook. If no Browse Paths have been generated before, this will be null.
browsePathV2 BrowsePathV2	The browse path V2 corresponding to an entity. If no Browse Paths V2 have been generated before, this will be null.
exists Boolean	Whether or not this entity exists on DataHub
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams

NotebookCell

The Union of every NotebookCell

Fields

Name	Description
chartCell ChartCell	The chart cell content. The will be non-null only when all other cell field is null.
textCell TextCell	The text cell content. The will be non-null only when all other cell field is null.
queryChell QueryCell	The query cell content. The will be non-null only when all other cell field is null.
type NotebookCellType!	The type of this Notebook cell

NotebookContent

The actual content in a Notebook

Fields

Name	Description
cells [NotebookCell!]!	The content of a Notebook which is composed by a list of NotebookCell

NotebookEditableProperties

Notebook properties that are editable via the UI This represents logical metadata, as opposed to technical metadata

Fields

Name	Description
description String	Description of the Notebook

NotebookInfo

Additional read only information about a Notebook

Fields

Name	Description
title String	Display of the Notebook
description String	Description of the Notebook
externalUrl String	Native platform URL of the Notebook
customProperties [CustomPropertiesEntry!]	A list of platform specific metadata tuples
changeAuditStamps ChangeAuditStamps	Captures information about who created/last modified/deleted this Notebook and when

NumberValue

Numeric property value

Fields

Name	Description
numberValue Float!	The value of a number type property

NumericDataPoint

For consumption by UI only

Fields

Name	Description
x String!
y Int!

Operation

Operational info for an entity.

Implements

• TimeSeriesAspect

Fields

Name	Description
timestampMillis Long!	The time at which the operation was reported
actor String	Actor who issued this operation.
operationType OperationType!	Operation type of change.
customOperationType String	A custom operation type
sourceType OperationSourceType	Source of the operation
numAffectedRows Long	How many rows were affected by this operation.
affectedDatasets [String!]	Which other datasets were affected by this operation.
lastUpdatedTimestamp Long!	When time at which the asset was actually updated
partition String	Optional partition identifier
customProperties [StringMapEntry!]	Custom operation properties

Origin

Carries information about where an entity originated from.

Fields

Name	Description
type OriginType!	Where an entity originated from. Either NATIVE or EXTERNAL
externalType String	Only populated if type is EXTERNAL. The externalType of the entity, such as the name of the identity provider.

Owner

An owner of a Metadata Entity

Fields

Name	Description
owner OwnerType!	Owner object
type OwnershipType	Deprecated: No longer supported The type of the ownership. Deprecated - Use ownershipType field instead.
ownershipType OwnershipTypeEntity	Ownership type information
source OwnershipSource	Source information for the ownership
associatedUrn String!	Reference back to the owned urn for tracking purposes e.g. when sibling nodes are merged together

Ownership

Ownership information about a Metadata Entity

Fields

Name	Description
owners [Owner!]	List of owners of the entity
lastModified AuditStamp!	Audit stamp containing who last modified the record and when

OwnershipSource

Information about the source of Ownership metadata about a Metadata Entity

Fields

Name	Description
type OwnershipSourceType!	The type of the source
url String	An optional reference URL for the source

OwnershipTypeEntity

A single Custom Ownership Type

Implements

• Entity

Fields

Name	Description
urn String!	A primary key associated with the custom ownership type.
type EntityType!	A standard Entity Type
info OwnershipTypeInfo	Information about the Custom Ownership Type
status Status	Status of the Custom Ownership Type
relationships EntityRelationshipsResult	Granular API for querying edges extending from the Custom Ownership Type Arguments Name Description input RelationshipsInput!

OwnershipTypeInfo

Properties about an individual Custom Ownership Type.

Fields

Name	Description
name String!	The name of the Custom Ownership Type
description String	The description of the Custom Ownership Type
created AuditStamp	An Audit Stamp corresponding to the creation of this resource
lastModified AuditStamp	An Audit Stamp corresponding to the update of this resource

ParentContainersResult

All of the parent containers for a given entity. Returns parents with direct parent first followed by the parent's parent etc.

Fields

Name	Description
count Int!	The number of containers bubbling up for this entity
containers [Container!]!	A list of parent containers in order from direct parent, to parent's parent etc. If there are no containers, return an emty list

ParentDomainsResult

All of the parent domains starting from a single Domain through all of its ancestors

Fields

Name	Description
count Int!	The number of parent domains bubbling up for this entity
domains [Entity!]!	A list of parent domains in order from direct parent, to parent's parent etc. If there are no parents, return an empty list

ParentNodesResult

All of the parent nodes for GlossaryTerms and GlossaryNodes

Fields

Name	Description
count Int!	The number of parent nodes bubbling up for this entity
nodes [GlossaryNode!]!	A list of parent nodes in order from direct parent, to parent's parent etc. If there are no nodes, return an empty list

PartitionSpec

Information about the partition being profiled

Fields

Name	Description
type PartitionType!	The partition type
partition String	The partition identifier
timePartition TimeWindow	The optional time window partition information - required if type is TIMESTAMP_FIELD.

PlatformPrivileges

The platform privileges that the currently authenticated user has

Fields

Name	Description
viewAnalytics Boolean!	Whether the user should be able to view analytics
managePolicies Boolean!	Whether the user should be able to manage policies
manageIdentities Boolean!	Whether the user should be able to manage users & groups
generatePersonalAccessTokens Boolean!	Whether the user should be able to generate personal access tokens
createDomains Boolean!	Whether the user should be able to create new Domains
manageDomains Boolean!	Whether the user should be able to manage Domains
manageIngestion Boolean!	Whether the user is able to manage UI-based ingestion
manageSecrets Boolean!	Whether the user is able to manage UI-based secrets
manageTokens Boolean!	Whether the user should be able to manage tokens on behalf of other users.
manageTests Boolean!	Whether the user is able to manage Tests
manageGlossaries Boolean!	Whether the user should be able to manage Glossaries
manageUserCredentials Boolean!	Whether the user is able to manage user credentials
createTags Boolean!	Whether the user should be able to create new Tags
manageTags Boolean!	Whether the user should be able to create and delete all Tags
manageGlobalViews Boolean!	Whether the user should be able to create, update, and delete global views.
manageOwnershipTypes Boolean!	Whether the user should be able to create, update, and delete ownership types.
manageGlobalAnnouncements Boolean!	Whether the user can create and delete posts pinned to the home page.
createBusinessAttributes Boolean!	Whether the user can create Business Attributes.
manageBusinessAttributes Boolean!	Whether the user can manage Business Attributes.

PoliciesConfig

Configurations related to the Policies Feature

Fields

Name	Description
enabled Boolean!	Whether the policies feature is enabled and should be displayed in the UI
platformPrivileges [Privilege!]!	A list of platform privileges to display in the Policy Builder experience
resourcePrivileges [ResourcePrivileges!]!	A list of resource privileges to display in the Policy Builder experience

Policy

DEPRECATED TODO: Eventually get rid of this in favor of DataHub Policy An DataHub Platform Access Policy Access Policies determine who can perform what actions against which resources on the platform

Fields

Name	Description
urn String!	The primary key of the Policy
type PolicyType!	The type of the Policy
name String!	The name of the Policy
state PolicyState!	The present state of the Policy
description String	The description of the Policy
resources ResourceFilter	The resources that the Policy privileges apply to
privileges [String!]!	The privileges that the Policy grants
actors ActorFilter!	The actors that the Policy grants privileges to
editable Boolean!	Whether the Policy is editable, ie system policies, or not

PolicyMatchCriterion

Criterion to define relationship between field and values

Fields

Name	Description
field String!	The name of the field that the criterion refers to e.g. entity_type, entity_urn, domain
values [PolicyMatchCriterionValue!]!	Values. Matches criterion if any one of the values matches condition (OR-relationship)
condition PolicyMatchCondition!	The name of the field that the criterion refers to

PolicyMatchCriterionValue

Value in PolicyMatchCriterion with hydrated entity if value is urn

Fields

Name	Description
value String!	The value of the field to match
entity Entity	Hydrated entities of the above values. Only set if the value is an urn

PolicyMatchFilter

Filter object that encodes a complex filter logic with OR + AND

Fields

Name	Description
criteria [PolicyMatchCriterion!]	List of criteria to apply

Post

Input provided when creating a Post

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the Post
type EntityType!	The standard Entity Type
relationships EntityRelationshipsResult	Granular API for querying edges extending from the Post Arguments Name Description input RelationshipsInput!
postType PostType!	The type of post
content PostContent!	The content of the post
lastModified AuditStamp!	When the post was last modified

PostContent

Post content

Fields

Name	Description
contentType PostContentType!	The type of post content
title String!	The title of the post
description String	Optional content of the post
link String	Optional link that the post is associated with
media Media	Optional media contained in the post

Privilege

An individual DataHub Access Privilege

Fields

Name	Description
type String!	Standardized privilege type, serving as a unique identifier for a privilege eg EDIT_ENTITY
displayName String	The name to appear when displaying the privilege, eg Edit Entity
description String	A description of the privilege to display

Privileges

Object that encodes the privileges the actor has for a given resource

Fields

Name	Description
privileges [String!]!	Granted Privileges

QuantitativeAnalyses

Fields

Name	Description
unitaryResults ResultsType	Link to a dashboard with results showing how the model performed with respect to each factor
intersectionalResults ResultsType	Link to a dashboard with results showing how the model performed with respect to the intersection of evaluated factors

QueriesTabConfig

Configuration for the queries tab

Fields

Name	Description
queriesTabResultSize Int	Number of queries to show in the queries tab

QueryCell

A Notebook cell which contains Query as content

Fields

Name	Description
cellTitle String!	Title of the cell
cellId String!	Unique id for the cell.
changeAuditStamps ChangeAuditStamps	Captures information about who created/last modified/deleted this TextCell and when
rawQuery String!	Raw query to explain some specific logic in a Notebook
lastExecuted AuditStamp	Captures information about who last executed this query cell and when

QueryEntity

An individual Query

Implements

• Entity

Fields

Name	Description
urn String!	A primary key associated with the Query
type EntityType!	A standard Entity Type
properties QueryProperties	Properties about the Query
subjects [QuerySubject!]	Subjects for the query
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
platform DataPlatform	Platform from which the Query was detected

QueryProperties

Properties about an individual Query

Fields

Name	Description
statement QueryStatement!	The Query statement itself
source QuerySource!	The source of the Query
name String	The name of the Query
description String	The description of the Query
created AuditStamp!	An Audit Stamp corresponding to the creation of this resource
lastModified AuditStamp!	An Audit Stamp corresponding to the update of this resource
origin Entity	The asset that this query originated from, e.g. a View, a dbt Model, etc.

QueryStatement

An individual Query Statement

Fields

Name	Description
value String!	The query statement value
language QueryLanguage!	The language for the Query Statement

QuerySubject

The subject for a Query

Fields

Name	Description
dataset Dataset!	The dataset which is the subject of the Query

QuickFilter

A quick filter in search and auto-complete

Fields

Name	Description
field String!	Name of field to filter by
value String!	Value to filter on
entity Entity	Entity that the value maps to if any

RawAspect

Payload representing data about a single aspect

Fields

Name	Description
aspectName String!	The name of the aspect
payload String	JSON string containing the aspect's payload
renderSpec AspectRenderSpec	Details for the frontend on how the raw aspect should be rendered

RecommendationContent

Content to display within each recommendation module

Fields

Name	Description
value String!	String representation of content
entity Entity	Entity being recommended. Empty if the content being recommended is not an entity
params RecommendationParams	Additional context required to generate the the recommendation

RecommendationModule

Fields

Name	Description
title String!	Title of the module to display
moduleId String!	Unique id of the module being recommended
renderType RecommendationRenderType!	Type of rendering that defines how the module should be rendered
content [RecommendationContent!]!	List of content to display inside the module

RecommendationParams

Parameters required to render a recommendation of a given type

Fields

Name	Description
searchParams SearchParams	Context to define the search recommendations
entityProfileParams EntityProfileParams	Context to define the entity profile page
contentParams ContentParams	Context about the recommendation

RelationshipFieldMapping

ERModelRelationship FieldMap

Fields

Name	Description
sourceField String!	left field
destinationField String!	bfield

ResetToken

Token that allows native users to reset their credentials

Fields

Name	Description
resetToken String!	The reset token

ResolvedAuditStamp

Audit stamp containing a resolved actor

Fields

Name	Description
time Long!	When the audited action took place
actor CorpUser	Who performed the audited action

ResourceFilter

The resources that a DataHub Access Policy applies to

Fields

Name	Description
type String	The type of the resource the policy should apply to Not required because in the future we want to support filtering by type OR by domain
resources [String!]	A list of specific resource urns to apply the filter to
allResources Boolean	Whether of not to apply the filter to all resources of the type
filter PolicyMatchFilter	Whether of not to apply the filter to all resources of the type

ResourcePrivileges

A privilege associated with a particular resource type A resource is most commonly a DataHub Metadata Entity

Fields

Name	Description
resourceType String!	Resource type associated with the Access Privilege, eg dataset
resourceTypeDisplayName String	The name to used for displaying the resourceType
entityType EntityType	An optional entity type to use when performing search and navigation to the entity
privileges [Privilege!]!	A list of privileges that are supported against this resource

Restricted

A restricted entity that the user does not have full permissions to view. This entity type does not relate to an entity type in the database.

Implements

• Entity
• EntityWithRelationships

Fields

Name	Description
urn String!	The primary key of the restricted entity
type EntityType!	The standard Entity Type
relationships EntityRelationshipsResult	Edges extending from this entity Arguments Name Description input RelationshipsInput!
lineage EntityLineageResult	Edges extending from this entity grouped by direction in the lineage graph Arguments Name Description input LineageInput!

Role

Implements

• Entity

Fields

Name	Description
urn String!	A primary key of the Metadata Entity
type EntityType!	A standard Entity Type
relationships EntityRelationshipsResult	List of relationships between the source Entity and some destination entities with a given types Arguments Name Description input RelationshipsInput!
id String!	Id of the Role
properties RoleProperties	Role properties to include Request Access Url
actors Actor	A standard Entity Type
isAssignedToMe Boolean!

RoleAssociation

Fields

Name	Description
role Role!	The Role entity itself
associatedUrn String!	Reference back to the tagged urn for tracking purposes e.g. when sibling nodes are merged together

RoleProperties

Fields

Name	Description
name String!	Name of the Role in an organisation
description String	Description about the role
type String	Role type can be READ, WRITE or ADMIN
requestUrl String	Url to request a role for a user in an organisation

RoleUser

Fields

Name	Description
user CorpUser!	Linked corp user of a role

Row

For consumption by UI only

Fields

Name	Description
values [String!]!
cells [Cell!]

Schema

Deprecated, use SchemaMetadata instead Metadata about a Dataset schema

Fields

Name	Description
datasetUrn String	Dataset this schema metadata is associated with
name String!	Schema name
platformUrn String!	Platform this schema metadata is associated with
version Long!	The version of the GMS Schema metadata
cluster String	The cluster this schema metadata is derived from
hash String!	The SHA1 hash of the schema content
platformSchema PlatformSchema	The native schema in the datasets platform, schemaless if it was not provided
fields [SchemaField!]!	Client provided a list of fields from value schema
primaryKeys [String!]	Client provided list of fields that define primary keys to access record
foreignKeys [ForeignKeyConstraint]	Client provided list of foreign key constraints
createdAt Long	The time at which the schema metadata information was created
lastObserved Long	The time at which the schema metadata information was last ingested

SchemaField

Information about an individual field in a Dataset schema

Fields

Name	Description
fieldPath String!	Flattened name of the field computed from jsonPath field
jsonPath String	Flattened name of a field in JSON Path notation
label String	Human readable label for the field. Not supplied by all data sources
nullable Boolean!	Indicates if this field is optional or nullable
description String	Description of the field
type SchemaFieldDataType!	Platform independent field type of the field
nativeDataType String	The native type of the field in the datasets platform as declared by platform schema
recursive Boolean!	Whether the field references its own type recursively
globalTags GlobalTags	Deprecated: No longer supported Deprecated, use tags field instead Tags associated with the field
tags GlobalTags	Tags associated with the field
glossaryTerms GlossaryTerms	Glossary terms associated with the field
isPartOfKey Boolean	Whether the field is part of a key schema
isPartitioningKey Boolean	Whether the field is part of a partitioning key schema
jsonProps String	For schema fields that have other properties that are not modeled explicitly, represented as a JSON string.
schemaFieldEntity SchemaFieldEntity	Schema field entity that exist in the database for this schema field

SchemaFieldBlame

Blame for a single field

Fields

Name	Description
fieldPath String!	Flattened name of a schema field
schemaFieldChange SchemaFieldChange!	Attributes identifying a field change

SchemaFieldChange

Attributes identifying a field change

Fields

Name	Description
timestampMillis Long!	The time at which the schema was updated
lastSemanticVersion String!	The last semantic version that this schema was changed in
versionStamp String!	Version stamp of the change
changeType ChangeOperationType!	The type of the change
lastSchemaFieldChange String	Last column update, such as Added/Modified/Removed in v1.2.3.

SchemaFieldEntity

Standalone schema field entity. Differs from the SchemaField struct because it is not directly nested inside a schema field

Implements

• Entity

Fields

Name	Description
urn String!	Primary key of the schema field
type EntityType!	A standard Entity Type
fieldPath String!	Field path identifying the field in its dataset
parent Entity!	The field's parent.
structuredProperties StructuredProperties	Structured properties on this schema field
forms Forms	The forms associated with the Dataset
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
businessAttributes BusinessAttributes	Business Attribute associated with the field

SchemaFieldRef

A Dataset schema field (i.e. column)

Fields

Name	Description
urn String!	A schema field urn
path String!	A schema field path

SchemaMetadata

Metadata about a Dataset schema

Implements

• Aspect

Fields

Name	Description
aspectVersion Long	The logical version of the schema metadata, where zero represents the latest version with otherwise monotonic ordering starting at one
datasetUrn String	Dataset this schema metadata is associated with
name String!	Schema name
platformUrn String!	Platform this schema metadata is associated with
version Long!	The version of the GMS Schema metadata
cluster String	The cluster this schema metadata is derived from
hash String!	The SHA1 hash of the schema content
platformSchema PlatformSchema	The native schema in the datasets platform, schemaless if it was not provided
fields [SchemaField!]!	Client provided a list of fields from value schema
primaryKeys [String!]	Client provided list of fields that define primary keys to access record
foreignKeys [ForeignKeyConstraint]	Client provided list of foreign key constraints
createdAt Long	The time at which the schema metadata information was created

ScrollAcrossLineageResults

Results returned by issuing a search across relationships query using scroll API

Fields

Name	Description
nextScrollId String	Opaque ID to pass to the next request to the server
count Int!	The number of entities included in the result set
total Int!	The total number of search results matching the query and filters
searchResults [SearchAcrossLineageResult!]!	The search result entities
facets [FacetMetadata!]	Candidate facet aggregations used for search filtering

ScrollResults

Results returned by issuing a search query

Fields

Name	Description
nextScrollId String	Opaque ID to pass to the next request to the server
count Int!	The number of entities included in the result set
total Int!	The total number of search results matching the query and filters
searchResults [SearchResult!]!	The search result entities for a scroll request
facets [FacetMetadata!]	Candidate facet aggregations used for search filtering

SearchAcrossLineageResult

Individual search result from a search across relationships query (has added metadata about the path)

Fields

Name	Description
entity Entity!	The resolved DataHub Metadata Entity matching the search query
insights [SearchInsight!]	Insights about why the search result was matched
matchedFields [MatchedField!]!	Matched field hint
paths [EntityPath]	Optional list of entities between the source and destination node
degree Int!	Degree of relationship (number of hops to get to entity)
degrees [Int!]	Degrees of relationship (for entities discoverable at multiple degrees)
explored Boolean!	Marks whether or not this entity was explored further for lineage
ignoredAsHop Boolean!	Whether this relationship was ignored as a hop

SearchAcrossLineageResults

Results returned by issuing a search across relationships query

Fields

Name	Description
start Int!	The offset of the result set
count Int!	The number of entities included in the result set
total Int!	The total number of search results matching the query and filters
searchResults [SearchAcrossLineageResult!]!	The search result entities
facets [FacetMetadata!]	Candidate facet aggregations used for search filtering
freshness FreshnessStats	Optional freshness characteristics of this query (cached, staleness etc.)

SearchInsight

Insights about why a search result was returned or ranked in the way that it was

Fields

Name	Description
text String!	The insight to display
icon String	An optional emoji to display in front of the text

SearchParams

Context to define the search recommendations

Fields

Name	Description
types [EntityType!]	Entity types to be searched. If this is not provided, all entities will be searched.
query String!	Search query
filters [FacetFilter!]	Filters

SearchResult

An individual search result hit

Fields

Name	Description
entity Entity!	The resolved DataHub Metadata Entity matching the search query
insights [SearchInsight!]	Insights about why the search result was matched
matchedFields [MatchedField!]!	Matched field hint

SearchResults

Results returned by issuing a search query

Fields

Name	Description
start Int!	The offset of the result set
count Int!	The number of entities included in the result set
total Int!	The total number of search results matching the query and filters
searchResults [SearchResult!]!	The search result entities
facets [FacetMetadata!]	Candidate facet aggregations used for search filtering
suggestions [SearchSuggestion!]	Search suggestions based on the query provided for alternate query texts

SearchResultsVisualConfig

Configuration for a search result

Fields

Name	Description
enableNameHighlight Boolean	Whether a search result should highlight the name/description if it was matched on those fields.

SearchSuggestion

A suggestion for an alternate search query given an original query compared to all of the entity names in our search index.

Fields

Name	Description
text String!	The suggested text based on the provided query text compared to the entity name field in the search index.
score Float	The "edit distance" for this suggestion. The closer this number is to 1, the closer the suggested text is to the original text. The closer it is to 0, the further from the original text it is.
frequency Int	The number of entities that would match on the name field given the suggested text

Secret

A referencible secret stored in DataHub's system. Notice that we do not return the actual secret value.

Fields

Name	Description
urn String!	The urn of the secret
name String!	The name of the secret
description String	An optional description for the secret

SecretValue

A plaintext secret value

Fields

Name	Description
name String!	The name of the secret
value String!	The plaintext value of the secret.

SemanticVersionStruct

Properties identify a semantic version

Fields

Name	Description
semanticVersion String	Semantic version of the change
semanticVersionTimestamp Long	Semantic version timestamp
versionStamp String	Version stamp of the change

SiblingProperties

Metadata about the entity's siblings

Fields

Name	Description
isPrimary Boolean	If this entity is the primary sibling among the sibling set
siblings [Entity]	The sibling entities

SourceCode

Fields

Name	Description
sourceCode [SourceCodeUrl!]	Source Code along with types

SourceCodeUrl

Fields

Name	Description
type SourceCodeUrlType!	Source Code Url Types
sourceCodeUrl String!	Source Code Url

Status

The status of a particular Metadata Entity

Fields

Name	Description
removed Boolean!	Whether the entity is removed or not

StepStateResult

A single step state

Fields

Name	Description
id String!	Unique id of the step
properties [StringMapEntry!]!	The properties for the step state

StringBox

Fields

Name	Description
stringValue String!

StringMapEntry

An entry in a string string map represented as a tuple

Fields

Name	Description
key String!	The key of the map entry
value String	The value fo the map entry

StringValue

String property value

Fields

Name	Description
stringValue String!	The value of a string type property

StructuredProperties

Object containing structured properties for an entity

Fields

Name	Description
properties [StructuredPropertiesEntry!]	Structured properties on this entity

StructuredPropertiesEntry

An entry in an structured properties list represented as a tuple

Fields

Name	Description
structuredProperty StructuredPropertyEntity!	The key of the map entry
values [PropertyValue]!	The values of the structured property for this entity
valueEntities [Entity]	The optional entities associated with the values if the values are entity urns

StructuredPropertyDefinition

Properties about an individual Query

Fields

Name	Description
qualifiedName String!	The fully qualified name of the property. This includes its namespace
displayName String	The display name of this structured property
description String	The description of this property
cardinality PropertyCardinality	The cardinality of a Structured Property determining whether one or multiple values can be applied to the entity from this property.
allowedValues [AllowedValue!]	A list of allowed values that the property is allowed to take.
valueType DataTypeEntity!	The type of this structured property
typeQualifier TypeQualifier	Allows for type specialization of the valueType to be more specific about which entity types are allowed, for example.
entityTypes [EntityTypeEntity!]!	Entity types that this structured property can be applied to
immutable Boolean!	Whether or not this structured property is immutable

StructuredPropertyEntity

A structured property that can be shared between different entities

Implements

• Entity

Fields

Name	Description
urn String!	A primary key associated with the structured property
type EntityType!	A standard Entity Type
definition StructuredPropertyDefinition!	Definition of this structured property including its name
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!

StructuredPropertyParams

A prompt shown to the user to collect metadata about an entity

Fields

Name	Description
structuredProperty StructuredPropertyEntity!	The structured property required for the prompt on this entity

StructuredReport

A flexible carrier for structured results of an execution request.

Fields

Name	Description
type String!	The type of the structured report. (e.g. INGESTION_REPORT, TEST_CONNECTION_REPORT, etc.)
serializedValue String!	The serialized value of the structured report
contentType String!	The content-type of the serialized value (e.g. application/json, application/json;gzip etc.)

SubTypes

Fields

Name	Description
typeNames [String!]	The sub-types that this entity implements. e.g. Datasets that are views will implement the "view" subtype

SystemFreshness

Fields

Name	Description
systemName String!	Name of the system
freshnessMillis Long!	The latest timestamp in millis of the system that was used to respond to this query In case a cache was consulted, this reflects the freshness of the cache In case an index was consulted, this reflects the freshness of the index

TableChart

For consumption by UI only

Fields

Name	Description
title String!
columns [String!]!
rows [Row!]!

TableSchema

Information about a raw Table Schema

Fields

Name	Description
schema String!	Raw table schema

Tag

A Tag Entity, which can be associated with other Metadata Entities and subresources

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the TAG
type EntityType!	A standard Entity Type
name String!	Deprecated: No longer supported A unique identifier for the Tag. Deprecated - Use properties.name field instead.
properties TagProperties	Additional properties about the Tag
editableProperties EditableTagProperties	Deprecated: No longer supported Additional read write properties about the Tag Deprecated! Use 'properties' field instead.
ownership Ownership	Ownership metadata of the dataset
relationships EntityRelationshipsResult	Granular API for querying edges extending from this entity Arguments Name Description input RelationshipsInput!
description String	Deprecated: No longer supported Deprecated, use properties.description field instead
aspects [RawAspect!]	Experimental API. For fetching extra entities that do not have custom UI code yet Arguments Name Description input AspectParams

TagAssociation

An edge between a Metadata Entity and a Tag Modeled as a struct to permit additional attributes TODO Consider whether this query should be serviced by the relationships field

Fields

Name	Description
tag Tag!	The tag itself
associatedUrn String!	Reference back to the tagged urn for tracking purposes e.g. when sibling nodes are merged together

TagProperties

Properties for a DataHub Tag

Fields

Name	Description
name String!	A display name for the Tag
description String	A description of the Tag
colorHex String	An optional RGB hex code for a Tag color, e.g. #FFFFFF

TelemetryConfig

Configurations related to tracking users in the app

Fields

Name	Description
enableThirdPartyLogging Boolean	Env variable for whether or not third party logging should be enabled for this instance

Test

A metadata entity representing a DataHub Test

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the Test itself
type EntityType!	The standard Entity Type
name String!	The name of the Test
category String!	The category of the Test (user defined)
description String	Description of the test
definition TestDefinition!	Definition for the test
relationships EntityRelationshipsResult	Unused for tests Arguments Name Description input RelationshipsInput!

TestDefinition

Definition of the test

Fields

Name	Description
json String	JSON-based def for the test Deprecated! JSON representation is no longer supported.

TestResult

The result of running a test

Fields

Name	Description
test Test	The test itself, or null if the test has been deleted
type TestResultType!	The final result, e.g. either SUCCESS or FAILURE.

TestResults

A set of test results

Fields

Name	Description
passing [TestResult!]!	The tests passing
failing [TestResult!]!	The tests failing

TestsConfig

Configurations related to DataHub Tests feature

Fields

Name	Description
enabled Boolean!	Whether Tests feature is enabled

TextCell

A Notebook cell which contains text as content

Fields

Name	Description
cellTitle String!	Title of the cell
cellId String!	Unique id for the cell.
changeAuditStamps ChangeAuditStamps	Captures information about who created/last modified/deleted this TextCell and when
text String!	The actual text in a TextCell in a Notebook

TimeSeriesChart

For consumption by UI only

Fields

Name	Description
title String!
lines [NamedLine!]!
dateRange DateRange!
interval DateInterval!

TimeWindow

A time window with a finite start and end time

Fields

Name	Description
startTimeMillis Long!	The start time of the time window
durationMillis Long!	The end time of the time window

TypeQualifier

Allows for type specialization of the valueType to be more specific about which entity types are allowed, for example.

Fields

Name	Description
allowedTypes [EntityTypeEntity!]	The list of allowed entity types

UpdateStepStateResult

Result returned when fetching step state

Fields

Name	Description
id String!	Id of the step
succeeded Boolean!	Whether the update succeeded.

UpstreamEntityRelationships

Deprecated, use relationships query instead

Fields

Name	Description
entities [EntityRelationshipLegacy]

UsageAggregation

An aggregation of Dataset usage statistics

Fields

Name	Description
bucket Long	The time window start time
duration WindowDuration	The time window span
resource String	The resource urn associated with the usage information, eg a Dataset urn
metrics UsageAggregationMetrics	The rolled up usage metrics

UsageAggregationMetrics

Rolled up metrics about Dataset usage over time

Fields

Name	Description
uniqueUserCount Int	The unique number of users who have queried the dataset within the time range
users [UserUsageCounts]	Usage statistics within the time range by user
totalSqlQueries Int	The total number of queries issued against the dataset within the time range
topSqlQueries [String]	A set of common queries issued against the dataset within the time range
fields [FieldUsageCounts]	Per field usage statistics within the time range

UsageQueryResult

The result of a Dataset usage query

Fields

Name	Description
buckets [UsageAggregation]	A set of relevant time windows for use in displaying usage statistics
aggregations UsageQueryResultAggregations	A set of rolled up aggregations about the Dataset usage

UsageQueryResultAggregations

A set of rolled up aggregations about the Dataset usage

Fields

Name	Description
uniqueUserCount Int	The count of unique Dataset users within the queried time range
users [UserUsageCounts]	The specific per user usage counts within the queried time range
fields [FieldUsageCounts]	The specific per field usage counts within the queried time range
totalSqlQueries Int	The total number of queries executed within the queried time range Note that this field will likely be deprecated in favor of a totalQueries field

UserUsageCounts

Information about individual user usage of a Dataset

Fields

Name	Description
user CorpUser	The user of the Dataset
count Int	The number of queries issued by the user
userEmail String	The extracted user email Note that this field will soon be deprecated and merged with user

VersionedDataset

A Dataset entity, which encompasses Relational Tables, Document store collections, streaming topics, and other sets of data having an independent lifecycle

Implements

• Entity

Fields

Name	Description
urn String!	The primary key of the Dataset
type EntityType!	The standard Entity Type
platform DataPlatform!	Standardized platform urn where the dataset is defined
container Container	The parent container in which the entity resides
parentContainers ParentContainersResult	Recursively get the lineage of containers for this entity
name String!	Unique guid for dataset No longer to be used as the Dataset display name. Use properties.name instead
properties DatasetProperties	An additional set of read only properties
editableProperties DatasetEditableProperties	An additional set of of read write properties
ownership Ownership	Ownership metadata of the dataset
deprecation Deprecation	The deprecation status of the dataset
institutionalMemory InstitutionalMemory	References to internal resources related to the dataset
editableSchemaMetadata EditableSchemaMetadata	Editable schema metadata of the dataset
status Status	Status of the Dataset
tags GlobalTags	Tags used for searching dataset
glossaryTerms GlossaryTerms	The structured glossary terms associated with the dataset
domain DomainAssociation	The Domain associated with the Dataset
health [Health!]	Experimental! The resolved health status of the asset
schema Schema	Schema metadata of the dataset
subTypes SubTypes	Sub Types that this entity implements
viewProperties ViewProperties	View related properties. Only relevant if subtypes field contains view.
origin FabricType!	Deprecated: No longer supported Deprecated, see the properties field instead Environment in which the dataset belongs to or where it was generated Note that this field will soon be deprecated in favor of a more standardized concept of Environment
relationships EntityRelationshipsResult	Deprecated: No longer supported No-op, has to be included due to model Arguments Name Description input RelationshipsInput!

VersionTag

The technical version associated with a given Metadata Entity

Fields

Name	Description
versionTag String

ViewProperties

Properties about a Dataset of type view

Fields

Name	Description
materialized Boolean!	Whether the view is materialized or not
logic String!	The logic associated with the view, most commonly a SQL statement
formattedLogic String	A formatted version of the logic associated with the view. For dbt, this contains the compiled SQL.
language String!	The language in which the view logic is written, for example SQL

ViewsConfig

Configurations related to DataHub Views feature

Fields

Name	Description
enabled Boolean!	Whether Views feature is enabled

VisualConfig

Configurations related to visual appearance of the app

Fields

Name	Description
logoUrl String	Custom logo url for the homepage & top banner
faviconUrl String	Custom favicon url for the homepage & top banner
appTitle String	Custom app title to show in the browser tab
hideGlossary Boolean	Boolean flag disabling viewing the Business Glossary page for users without the 'Manage Glossaries' privilege
queriesTab QueriesTabConfig	Configuration for the queries tab
entityProfiles EntityProfilesConfig	Configuration for the queries tab
searchResult SearchResultsVisualConfig	Configuration for search results