OBJECT
Metric

Metrics are time series data constructed from fields contained in views.
Retired in Tableau Cloud February 2024 / Server 2024.2.
GraphQL Schema definition

type Metric implements Taggable {
#   Unique identifier used by the metadata API.  Not the same as the numeric ID used 
#   on server
id: ID! 
#   Name shown in server and desktop clients
name: String 
#   Locally unique identifier used for the REST API on the Tableau Server
luid: String! 
#   The site in which the Metric is visible and usable
site: TableauSite! 
#   The ID of the project in which the Metric is visible and usable.
projectVizportalUrlId: String! 
#   VizPortal URL ID; used for URL generation
vizportalUrlId: String! 
#   The name of the project in which the Metric is visible and usable.
projectName: String 
#   The type of the container in which the metric is visible and usable. This is 
#   always a project.
containerType: String! 
#   The name of the container in which the metric is visible and usable. This is 
#   always a project.
containerName: String 
#   User who owns this Metric
owner: TableauUser! 
#   The original View off of which the Metric is based
underlyingView: View 
#   Description of the Metric
description: String 
#   Time the Metric was created
createdAt: DateTime! 
#   Time the Metric was last updated
updatedAt: DateTime! 
#   Tags associated with the Metric
# 
# 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.
tags(filter: Tag_Filter, orderBy: TagSortOrder): [Tag!]! 
#   Tags associated with the Metric
# 
# 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.
tagsConnection(
after: String,
first: Int,
offset: Int,
filter: Tag_Filter,
orderBy: TagSortOrder
): TagsConnection 
#   Data quality warnings upstream from this Metric
# 
# 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.
upstreamDataQualityWarnings(
filter: DataQualityWarning_Filter,
orderBy: DataQualityWarningSortOrder,
permissionMode: PermissionMode
): [DataQualityWarning!]! 
#   Data quality warnings upstream from this Metric
# 
# 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.
upstreamDataQualityWarningsConnection(
after: String,
first: Int,
offset: Int,
filter: DataQualityWarning_Filter,
orderBy: DataQualityWarningSortOrder,
permissionMode: PermissionMode
): DataQualityWarningsConnection 
#   Labels upstream from this Metric. Available in Tableau Cloud March 2023 / Server 
#   2023.1 and later.
# 
# 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 this Metric. Available in Tableau Cloud March 2023 / Server 
#   2023.1 and later.
# 
# 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 
#   Databases that are upstream of this metric
# 
# 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 that are upstream of this metric
# 
# 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 
#   OutputFields that are upstream of this Metric
# 
# 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] 
#   OutputFields that are upstream of this Metric
# 
# 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 
#   fields that are upstream of this metric
# 
# 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 that are upstream of this metric
# 
# 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 
#   tables that are upstream of this metric
# 
# 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 that are upstream of this metric
# 
# 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 
#   The flows that are upstream of this metric
# 
# 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] 
#   The flows that are upstream of this metric
# 
# 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 
#   OutputFields that are upstream of this Metric
# 
# 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.
upstreamFlowColumnOutputFields(
filter: FlowColumnOutputField_Filter,
orderBy: FlowColumnOutputFieldSortOrder,
permissionMode: PermissionMode
): [FlowColumnOutputField] 
#   OutputFields that are upstream of this Metric
# 
# 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.
upstreamFlowColumnOutputFieldsConnection(
after: String,
first: Int,
offset: Int,
filter: FlowColumnOutputField_Filter,
orderBy: FlowColumnOutputFieldSortOrder,
permissionMode: PermissionMode
): FlowColumnOutputFieldsConnection 
#   OutputFields that are upstream of this Metric
# 
# 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.
upstreamFlowFieldOutputFields(
filter: FlowFieldOutputField_Filter,
orderBy: FlowFieldOutputFieldSortOrder,
permissionMode: PermissionMode
): [FlowFieldOutputField] 
#   OutputFields that are upstream of this Metric
# 
# 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.
upstreamFlowFieldOutputFieldsConnection(
after: String,
first: Int,
offset: Int,
filter: FlowFieldOutputField_Filter,
orderBy: FlowFieldOutputFieldSortOrder,
permissionMode: PermissionMode
): FlowFieldOutputFieldsConnection 
#   The Lenses that are upstream of this workbook
# 
# 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.
upstreamLenses(
filter: Lens_Filter,
orderBy: LensSortOrder,
permissionMode: PermissionMode
): [Lens] 
#   The Lenses that are upstream of this workbook
# 
# 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.
upstreamLensesConnection(
after: String,
first: Int,
offset: Int,
filter: Lens_Filter,
orderBy: LensSortOrder,
permissionMode: PermissionMode
): LensesConnection 
#   Workbooks that are upstream of this metric
# 
# 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.
upstreamWorkbooks(
filter: Workbook_Filter,
orderBy: WorkbookSortOrder,
permissionMode: PermissionMode
): [Workbook] 
#   Workbooks that are upstream of this metric
# 
# 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.
upstreamWorkbooksConnection(
after: String,
first: Int,
offset: Int,
filter: Workbook_Filter,
orderBy: WorkbookSortOrder,
permissionMode: PermissionMode
): WorkbooksConnection 
#   Columns that are upstream of this metric
# 
# 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 that are upstream of this metric
# 
# 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 
#   The Published Datasources that are upstream to this Metric
# 
# 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] 
#   The Published Datasources that are upstream to this Metric
# 
# 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 
}
Metric

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
