INTERFACE

View

A view contained in a published workbook. Views can be sheets or dashboards.

link GraphQL Schema definition

  • interface View {
  • # 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
  • # Unique ID for the view generated for and stored within the workbook, survives
  • # renames, and is used for internal processes
  • documentViewId: String
  • # Locally unique identifier used for the REST API on the Tableau Server (Blank if
  • # sheet is hidden in Workbook)
  • luid: String!
  • # Server path to view
  • path: String
  • # Time the view was created
  • createdAt: DateTime!
  • # Time the view was updated
  • updatedAt: DateTime!
  • # Index of view; the order it appears in the workbook
  • index: Int
  • # Tags associated with the view
  • #
  • # 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 view
  • #
  • # 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 view
  • #
  • # 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 view
  • #
  • # 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 view. 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 view. 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
  • # The workbook that contains this view
  • workbook: Workbook
  • # The Metrics that reference this View
  • #
  • # 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.
  • referencedByMetrics(
  • filter: Metric_Filter,
  • orderBy: MetricSortOrder,
  • permissionMode: PermissionMode
  • ): [Metric]
  • # The Metrics that reference this View
  • #
  • # 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.
  • referencedByMetricsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Metric_Filter,
  • orderBy: MetricSortOrder,
  • permissionMode: PermissionMode
  • ): MetricsConnection
  • }