OBJECT
MetricDefinition

A Tableau Pulse metric definition.
Available in Tableau Cloud June 2024 and later. Tableau Pulse is not available in Tableau Server.
GraphQL Schema definition

type MetricDefinition {
#   Unique identifier used by the Metadata API. Not the same as the locally unique 
#   identifier used with the REST API.
id: ID! 
#   Name of the metric definition.
name: String! 
#   Locally unique identifier used for the REST API on the Tableau Server.
luid: String! 
#   The site which contains the metric definition.
site: TableauSite! 
#   Fields contained in the metric definition
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
fields(
filter: Field_Filter,
orderBy: FieldSortOrder,
permissionMode: PermissionMode
): [Field!]! 
#   Fields contained in the metric definition
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
fieldsConnection(
after: String,
first: Int,
offset: Int,
filter: Field_Filter,
orderBy: FieldSortOrder,
permissionMode: PermissionMode
): FieldsConnection 
#   Data sources upstream from the metric definition.
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamDatasources(
filter: PublishedDatasource_Filter,
orderBy: PublishedDatasourceSortOrder,
permissionMode: PermissionMode
): [PublishedDatasource!]! 
#   Data sources upstream from the metric definition.
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamDatasourcesConnection(
after: String,
first: Int,
offset: Int,
filter: PublishedDatasource_Filter,
orderBy: PublishedDatasourceSortOrder,
permissionMode: PermissionMode
): PublishedDatasourcesConnection 
#   Labels upstream from the metric definition.
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamLabels(
filter: Label_Filter,
orderBy: LabelSortOrder,
permissionMode: PermissionMode
): [Label!]! 
#   Labels upstream from the metric definition.
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamLabelsConnection(
after: String,
first: Int,
offset: Int,
filter: Label_Filter,
orderBy: LabelSortOrder,
permissionMode: PermissionMode
): LabelsConnection 
#   Flows upstream from the metric definition.
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamFlows(
filter: Flow_Filter,
orderBy: FlowSortOrder,
permissionMode: PermissionMode
): [Flow!]! 
#   Flows upstream from the metric definition.
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamFlowsConnection(
after: String,
first: Int,
offset: Int,
filter: Flow_Filter,
orderBy: FlowSortOrder,
permissionMode: PermissionMode
): FlowsConnection 
#   Databases upstream from the metric definition
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamDatabases(
filter: Database_Filter,
orderBy: DatabaseSortOrder,
permissionMode: PermissionMode
): [Database!]! 
#   Databases upstream from the metric definition
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamDatabasesConnection(
after: String,
first: Int,
offset: Int,
filter: Database_Filter,
orderBy: DatabaseSortOrder,
permissionMode: PermissionMode
): DatabasesConnection 
#   Tables upstream from the metric definition.
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamTables(
filter: DatabaseTable_Filter,
orderBy: DatabaseTableSortOrder,
permissionMode: PermissionMode
): [DatabaseTable!]! 
#   Tables upstream from the metric definition.
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamTablesConnection(
after: String,
first: Int,
offset: Int,
filter: DatabaseTable_Filter,
orderBy: DatabaseTableSortOrder,
permissionMode: PermissionMode
): DatabaseTablesConnection 
#   Virtual connection tables upstream from the metric definition.
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamVirtualConnectionTables(
filter: VirtualConnectionTable_Filter,
orderBy: VirtualConnectionTableSortOrder,
permissionMode: PermissionMode
): [VirtualConnectionTable!]! 
#   Virtual connection tables upstream from the metric definition.
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamVirtualConnectionTablesConnection(
after: String,
first: Int,
offset: Int,
filter: VirtualConnectionTable_Filter,
orderBy: VirtualConnectionTableSortOrder,
permissionMode: PermissionMode
): VirtualConnectionTablesConnection 
#   Fields upstream from the metric definition.
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamFields(
filter: Field_Filter,
orderBy: FieldSortOrder,
permissionMode: PermissionMode
): [Field!]! 
#   Fields upstream from the metric definition.
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamFieldsConnection(
after: String,
first: Int,
offset: Int,
filter: Field_Filter,
orderBy: FieldSortOrder,
permissionMode: PermissionMode
): FieldsConnection 
#   Flow output fields upstream from the metric definition.
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamFlowOutputFields(
filter: FlowOutputField_Filter,
orderBy: FlowOutputFieldSortOrder,
permissionMode: PermissionMode
): [FlowOutputField!]! 
#   Flow output fields upstream from the metric definition.
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamFlowOutputFieldsConnection(
after: String,
first: Int,
offset: Int,
filter: FlowOutputField_Filter,
orderBy: FlowOutputFieldSortOrder,
permissionMode: PermissionMode
): FlowOutputFieldsConnection 
#   Columns upstream from the metric definition.
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamColumns(
filter: Column_Filter,
orderBy: ColumnSortOrder,
permissionMode: PermissionMode
): [Column!]! 
#   Columns upstream from the metric definition.
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamColumnsConnection(
after: String,
first: Int,
offset: Int,
filter: Column_Filter,
orderBy: ColumnSortOrder,
permissionMode: PermissionMode
): ColumnsConnection 
#   Virtual connections upstream from the metric definition.
# 
# Arguments
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamVirtualConnections(
filter: VirtualConnection_Filter,
orderBy: VirtualConnectionSortOrder,
permissionMode: PermissionMode
): [VirtualConnection!]! 
#   Virtual connections upstream from the metric definition.
# 
# Arguments
#   after: The cursor to receive the next page of objects. If no 
#   cursor is supplied it will start at the beginning of the list. Offset can not be 
#   set at the same time. This is the preferred API to use if possible as it is 
#   faster.
#   first: Maximum number of objects to be returned in a page. The 
#   default is 100
#   offset: The number of entries to offset the start of the page 
#   by. If no offset is supplied it will start at the beginning of the list. After 
#   can not be set at the same time.
#   filter: Filter by GraphQL field and given value
#   orderBy: Sort by given fields. The sort orders defined first in 
#   the list will take priority. If there are no given sort orders or a tie on the 
#   final sorted field then the resulting set will be sorted by ID in ascending 
#   order.
#   permissionMode: Results filtering mode.
upstreamVirtualConnectionsConnection(
after: String,
first: Int,
offset: Int,
filter: VirtualConnection_Filter,
orderBy: VirtualConnectionSortOrder,
permissionMode: PermissionMode
): VirtualConnectionsConnection 
}
MetricDefinition

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
