--- schema_version: "1" id: 1fb7f2555b4c6073976ad5ec05046774794992e716e14126b576585169766be0 title: Datasource collection: tableau version: next locale: en-us portal_url: https://docs.salesforce.com/tableau/next/en-us/api/metadata_api/reference/datasource.doc.md canonical_url: https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasource.doc.html source_site: help.tableau.com content_type: documentation content_hash: 0ed40b0c4648bf2f72e467a12405919865c07e7b34d982c7b6a7af19ab1237c3 --- _menu_ Types INTERFACE # Datasource Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See [https://onlinehelp.tableau.com/current/server/en-us/datasource.htm](https://onlinehelp.tableau.com/current/server/en-us/datasource.htm) ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - interface Datasource { - # Unique identifier used by the metadata API. Not the same as the numeric ID used - # on server - id: [ID](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/id.doc.html)! - # Name shown in server and desktop clients - name: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html) - # True if data source contains a formula that involves a user function (for - # example, USERNAME or ISMEMBEROF) - hasUserReference: [Boolean](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/boolean.doc.html) - # True if datasource contains extracted data - hasExtracts: [Boolean](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/boolean.doc.html) - # True if the datasource contains unsupported custom SQL, in which case lineage - # may be incomplete - containsUnsupportedCustomSql: [Boolean](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/boolean.doc.html) - # Time an extract was last fully refreshed - extractLastRefreshTime: [DateTime](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datetime.doc.html) - # Time an extract was last incrementally updated - extractLastIncrementalUpdateTime: [DateTime](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datetime.doc.html) - # Time an extract was last updated by either a full refresh, incremental update, - # or creation - extractLastUpdateTime: [DateTime](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datetime.doc.html) - # Fields usable in workbooks connected to this data source - # - # 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](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Field](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/field.doc.html)!]! - # Fields usable in workbooks connected to this data source - # - # 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](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Field_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/field_filter.doc.html), - orderBy: [FieldSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/fieldsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [FieldsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/fieldsconnection.doc.html) - # Data source filters contained in this data source - # - # 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. - datasourceFilters( - filter: [DatasourceFilter_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatasourceFilter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasourcefilter.doc.html)!]! - # Data source filters contained in this data source - # - # 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. - datasourceFiltersConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatasourceFilter_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasourcefilter_filter.doc.html), - orderBy: [DatasourceFilterSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasourcefiltersortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatasourceFiltersConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasourcefiltersconnection.doc.html) - # Sheets downstream from this data source - # - # 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. - downstreamSheets( - filter: [Sheet_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Sheet](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheet.doc.html)!]! - # Sheets downstream from this data source - # - # 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. - downstreamSheetsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Sheet_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheet_filter.doc.html), - orderBy: [SheetSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheetsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [SheetsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheetsconnection.doc.html) - # Dashboards downstream from this data source - # - # 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. - downstreamDashboards( - filter: [Dashboard_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Dashboard](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboard.doc.html)!]! - # Dashboards downstream from this data source - # - # 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. - downstreamDashboardsConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Dashboard_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboard_filter.doc.html), - orderBy: [DashboardSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboardsortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DashboardsConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboardsconnection.doc.html) - # Workbooks downstream from this data source - # - # 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. - downstreamWorkbooks( - filter: [Workbook_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Workbook](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Workbooks downstream from this data source - # - # 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. - downstreamWorkbooksConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Workbook_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbook_filter.doc.html), - orderBy: [WorkbookSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbooksortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [WorkbooksConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbooksconnection.doc.html) - # Workbook owners downstream from this data source - # - # 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. - downstreamOwners( - filter: [TableauUser_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [[TableauUser](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser.doc.html)!]! - # Workbook owners downstream from this data source - # - # 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. - downstreamOwnersConnection( - after: [String](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [TableauUser_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser_filter.doc.html), - orderBy: [TableauUserSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauusersortorder.doc.html) - ): [TableauUsersConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauusersconnection.doc.html) - # Tables upstream from this data source - # - # 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](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[DatabaseTable](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetable.doc.html)!]! - # Tables upstream from this data source - # - # 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](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [DatabaseTable_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetable_filter.doc.html), - orderBy: [DatabaseTableSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetablesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabaseTablesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetablesconnection.doc.html) - # Databases upstream from this data source - # - # 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](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Database](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/database.doc.html)!]! - # Databases upstream from this data source - # - # 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](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Database_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/database_filter.doc.html), - orderBy: [DatabaseSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasesortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [DatabasesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasesconnection.doc.html) - # Time the datasource was created. Available in Tableau Cloud June 2022 / Server - # 2022.3 and later. - createdAt: [DateTime](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datetime.doc.html) - # Time the datasource was last updated. Available in Tableau Cloud June 2022 / - # Server 2022.3 and later. - updatedAt: [DateTime](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datetime.doc.html) - # The lenses derived from this datasource - # - # 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/v0.0/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [[Lens](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lens.doc.html)] - # The lenses derived from this datasource - # - # 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/v0.0/api/metadata_api/en-us/reference/string.doc.html), - first: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - offset: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html), - filter: [Lens_Filter](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lens_filter.doc.html), - orderBy: [LensSortOrder](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lenssortorder.doc.html), - permissionMode: [PermissionMode](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/permissionmode.doc.html) - ): [LensesConnection](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/lensesconnection.doc.html) - } ` ## [_link_](#require-by) Require by - [AnalyticsField_Base GraphQL type for a field containing analytics metadata_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/analyticsfield.doc.html "AnalyticsField - Base GraphQL type for a field containing analytics metadata") - [BinField_GraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_bins.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/binfield.doc.html "BinField - GraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_bins.html") - [CalculatedField_GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_calculatedfields.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/calculatedfield.doc.html "CalculatedField - GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_calculatedfields.html") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/columnfield.doc.html "ColumnField - ColumnFields are a type of field which directly connects to a column in some type of table.") - [CombinedField_GraphQL type for a combined field. Combined fields concatanate fields together into one string._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/combinedfield.doc.html "CombinedField - GraphQL type for a combined field. Combined fields concatanate fields together into one string.") - [CombinedSetField_GraphQL type for a combined set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_sets\_create.html#Combine_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/combinedsetfield.doc.html "CombinedSetField - GraphQL type for a combined set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html#Combine") - [Dashboard_A dashboard contained in a published workbook._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/dashboard.doc.html "Dashboard - A dashboard contained in a published workbook.") - [DataField_Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datafield.doc.html "DataField - Base GraphQL type for a field containing data. Most types of Fields will implement this interface with exceptions like HierarchyField.") - [DatasourceField_GraphQL type for a data source field. Data source fields can only exist in embedded data sources which connect to a published data source. A data source field is an embedded data source's 'layered' representation of a field that already exists in the published data source and is mostly a copy of the field in the published data source. Data source fields can get their own descriptions and renames local to the embedded data source, but cannot otherwise be modified in the embedded data source._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasourcefield.doc.html "DatasourceField - GraphQL type for a data source field. Data source fields can only exist in embedded data sources which connect to a published data source. A data source field is an embedded data source's 'layered' representation of a field that already exists in the published data source and is mostly a copy of the field in the published data source. Data source fields can get their own descriptions and renames local to the embedded data source, but cannot otherwise be modified in the embedded data source.") - [DatasourceFilter_Data source filters include/exclude certain values from a single field to filter out rows of data from this data source. For data security reasons, we don't track the values used in the filter in this schema, but you can see the field used in the filter. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/filtering\_datasource.html_](datasourcefilter.doc.html "DatasourceFilter - Data source filters include/exclude certain values from a single field to filter out rows of data from this data source. For data security reasons, we don't track the values used in the filter in this schema, but you can see the field used in the filter. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/filtering_datasource.html") - [DatasourcesConnection_Connection Type for Datasource_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasourcesconnection.doc.html "DatasourcesConnection - Connection Type for Datasource") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [FieldReferencingField_Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/fieldreferencingfield.doc.html "FieldReferencingField - Base GraphQL type for a field that references another field. For example, a CalculatedField can reference a ColumnField in its formula.") - [GroupField_GraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_groups\_creating.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/groupfield.doc.html "GroupField - GraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_groups_creating.html") - [HierarchyField_GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs\_hierarchies.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/hierarchyfield.doc.html "HierarchyField - GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs_hierarchies.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.\*_](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.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/v0.0/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/v0.0/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [SetField_GraphQL type for a set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_sets\_create.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/setfield.doc.html "SetField - GraphQL type for a set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html") - [Sheet_A sheet contained in a published workbook._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/sheet.doc.html "Sheet - A sheet contained in a published workbook.")