---
schema_version: "1"
id: 426553521dcb092866c6ced4e85967762871a387d5e02b19f10c1170d90b88a2
title: View
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/metadata_api/reference/view.doc.md
canonical_url: https://help.tableau.com/current/api/metadata_api/en-us/reference/view.doc.html
source_site: help.tableau.com
content_type: documentation
content_hash: 153fba17452ac3bd5b74cfdfe315c31eed8042ddac65e5d504e940509a9ca0ac
---
_menu_ Types

INTERFACE

# View

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

## [_link_](#graphql-schema-definition) GraphQL Schema definition

`   - interface View {  - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/current/api/metadata_api/en-us/reference/id.doc.html)!  - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)  - # Unique ID for the view generated for and stored within the workbook, survives - # renames, and is used for internal processes - documentViewId: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)  - # Locally unique identifier used for the REST API on the Tableau Server (Blank if - # sheet is hidden in Workbook) - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)!  - # Server path to view - path: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)  - # Time the view was created - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)!  - # Time the view was updated - updatedAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)!  - # Index of view; the order it appears in the workbook - index: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html)  - # 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](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html)): [[Tag](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html)!]!  - # 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](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Tag_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag_filter.doc.html), - orderBy: [TagSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsortorder.doc.html) - ): [TagsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/tagsconnection.doc.html)  - # 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](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DataQualityWarning](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning.doc.html)!]!  - # 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](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [DataQualityWarning_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarning_filter.doc.html), - orderBy: [DataQualityWarningSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DataQualityWarningsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/dataqualitywarningsconnection.doc.html)  - # 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](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Label](https://help.tableau.com/current/api/metadata_api/en-us/reference/label.doc.html)!]!  - # 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](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Label_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/label_filter.doc.html), - orderBy: [LabelSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LabelsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/labelsconnection.doc.html)  - # The workbook that contains this view - workbook: [Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)  - # 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](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Metric](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric.doc.html)]  - # 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](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/current/api/metadata_api/en-us/reference/int.doc.html), - filter: [Metric_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metric_filter.doc.html), - orderBy: [MetricSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricsconnection.doc.html) - }   `

## [_link_](#require-by) Require by

- [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.")

- [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views.  
    *Retired in Tableau Cloud February 2024 / Server 2024.2.*")

- [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/current/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface")

- [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/current/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.")

- [Tag_A tag associated with content items_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items")

- [ViewsConnection_Connection Type for View_](https://help.tableau.com/current/api/metadata_api/en-us/reference/viewsconnection.doc.html "ViewsConnection - Connection Type for View")

- [Workbook_Workbooks are used to package up Tableau visualizations (which are called "sheets" in the Metadata API) and data models (which are called "embedded data sources" when they are owned by a workbook)._](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html "Workbook - Workbooks are used to package up Tableau visualizations (which are called \"sheets\" in the Metadata API) and data models (which are called \"embedded data sources\" when they are owned by a workbook).")