---
schema_version: "1"
id: 9348eae2d28e280def6d9256c416a11be75cc570f0fc92420aad91ce33ef54ce
title: TableauSite
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/metadata_api/reference/tableausite.doc.md
canonical_url: https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausite.doc.html
source_site: help.tableau.com
content_type: documentation
content_hash: b0c84f95d51f7a59317da1eaad05524a3e5ce7a2ee55880720d3286b192ce52f
---
_menu_ Types

OBJECT

# TableauSite

Site on Tableau server

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

`   - type TableauSite {  - # 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)!  - # URI of this site, e.g., 'sites/4' - uri: [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 - luid: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)!  - # Name shown in server - name: [String](https://help.tableau.com/current/api/metadata_api/en-us/reference/string.doc.html)!  - # Time the site was created. Available in Tableau Cloud June 2022 / Server 2022.3 - # and later. - createdAt: [DateTime](https://help.tableau.com/current/api/metadata_api/en-us/reference/datetime.doc.html)  - # Metric definitions that are part of this site. - # - # 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. - metricDefinitions( - filter: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[MetricDefinition](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition.doc.html)]  - # Metric definitions that are part of this site. - # - # 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. - metricDefinitionsConnection( - 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: [MetricDefinition_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinition_filter.doc.html), - orderBy: [MetricDefinitionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [MetricDefinitionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/metricdefinitionsconnection.doc.html)  - # The published data sources that are part of this site - # - # 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. - publishedDatasources( - filter: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[PublishedDatasource](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html)]  - # The published data sources that are part of this site - # - # 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. - publishedDatasourcesConnection( - 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: [PublishedDatasource_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource_filter.doc.html), - orderBy: [PublishedDatasourceSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [PublishedDatasourcesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasourcesconnection.doc.html)  - # The workbooks that are part of this site - # - # 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. - workbooks( - filter: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook.doc.html)]  - # The workbooks that are part of this site - # - # 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. - workbooksConnection( - 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: [Workbook_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/workbooksconnection.doc.html)  - # The Lenses that are part of this site - # - # 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. - lenses( - filter: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens.doc.html)]  - # The Lenses that are part of this site - # - # 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. - lensesConnection( - 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: [Lens_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/lensesconnection.doc.html)  - # The flows that are part of this site - # - # 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. - flows( - filter: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Flow](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html)]  - # The flows that are part of this site - # - # 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. - flowsConnection( - 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: [Flow_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow_filter.doc.html), - orderBy: [FlowSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FlowsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/flowsconnection.doc.html)  - # The virtual connections that are part of this site - # - # 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. - virtualConnections( - filter: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[VirtualConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection.doc.html)]  - # The virtual connections that are part of this site - # - # 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. - virtualConnectionsConnection( - 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: [VirtualConnection_Filter](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnection_filter.doc.html), - orderBy: [VirtualConnectionSortOrder](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/current/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [VirtualConnectionsConnection](https://help.tableau.com/current/api/metadata_api/en-us/reference/virtualconnectionsconnection.doc.html)  - # The Metrics that are part of this site - # - # 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. - metrics( - 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 are part of this site - # - # 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. - metricsConnection( - 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

- [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/current/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.")

- [Lens_Lenses are curated, embeddable Ask Data experiences. \*Introduced in Tableau Cloud June 2022 / Server 2022.3.\* \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](lens.doc.html "Lens - Lenses are curated, embeddable Ask Data experiences.  
    *Introduced in Tableau Cloud June 2022 / Server 2022.3.*  
    *Retired in Tableau Cloud February 2024 / Server 2024.2.*")

- [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.*")

- [MetricDefinition_A Tableau Pulse metric definition. \*Available in Tableau Cloud June 2024 and later. Tableau Pulse is not available in Tableau Server.\*_](metricdefinition.doc.html "MetricDefinition - A Tableau Pulse metric definition.  
    *Available in Tableau Cloud June 2024 and later. Tableau Pulse is not available in Tableau Server.*")

- [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/current/api/metadata_api/en-us/reference/publisheddatasource.doc.html "PublishedDatasource - A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks.")

- [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")

- [TableauSitesConnection_Connection Type for TableauSite_](https://help.tableau.com/current/api/metadata_api/en-us/reference/tableausitesconnection.doc.html "TableauSitesConnection - Connection Type for TableauSite")

- [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection.  
    *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*")

- [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).")