OBJECT
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.
link GraphQL Schema definition
- type Lens {
- # Unique identifier used by the metadata API. Not the same as the numeric ID used
- # on server
- ID! :
- # Name shown in server
- String :
- # Locally unique identifier used for the REST API on the Tableau Server
- String! :
- # The site in which the Lens is visible and usable
- TableauSite! :
- # The list of fields
- #
- # 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.
- (
- LensField_Filter, :
- LensFieldSortOrder, :
- PermissionMode :
- ): [LensField!]!
- # The list of fields
- #
- # 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.
- (
- String, :
- Int, :
- Int, :
- LensField_Filter, :
- LensFieldSortOrder, :
- PermissionMode :
- ): LensFieldsConnection
- # The ID of the project in which the Lens is visible and usable.
- String! :
- # VizPortal URL ID; used for URL generation
- String! :
- # Datasource this lens is derived from
- Datasource! :
- # User who owns this Lens
- TableauUser! :
- # Description of the Lens
- String :
- # Time the Lens was created
- DateTime! :
- # Time the Lens was last updated
- DateTime! :
- # "Dashboards connected to the Lens"
- #
- # 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.
- (
- Dashboard_Filter, :
- DashboardSortOrder, :
- PermissionMode :
- ): [Dashboard!]!
- # 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.
- (
- String, :
- Int, :
- Int, :
- Dashboard_Filter, :
- DashboardSortOrder, :
- PermissionMode :
- ): DashboardsConnection
- # "Workbooks connected to the Lens"
- #
- # 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.
- (
- Workbook_Filter, :
- WorkbookSortOrder, :
- PermissionMode :
- ): [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.
- (
- String, :
- Int, :
- Int, :
- Workbook_Filter, :
- WorkbookSortOrder, :
- PermissionMode :
- ): WorkbooksConnection
- # "Metrics connected to the Lens"
- #
- # 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.
- (
- Metric_Filter, :
- MetricSortOrder, :
- PermissionMode :
- ): [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.
- (
- String, :
- Int, :
- Int, :
- Metric_Filter, :
- MetricSortOrder, :
- PermissionMode :
- ): MetricsConnection
- # Owners of contents connected to the Lens
- #
- # 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.
- (
- TableauUser_Filter, :
- TableauUserSortOrder :
- ): [TableauUser!]!
- # Owners of contents connected to the Lens
- #
- # 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.
- (
- String, :
- Int, :
- Int, :
- TableauUser_Filter, :
- TableauUserSortOrder :
- ): TableauUsersConnection
- # Tables that are upstream of this Lens
- #
- # 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.
- (
- Table_Filter, :
- TableSortOrder, :
- PermissionMode :
- ): [Table!]!
- # Tables that are upstream of this Lens
- #
- # 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.
- (
- String, :
- Int, :
- Int, :
- Table_Filter, :
- TableSortOrder, :
- PermissionMode :
- ): TablesConnection
- # The lens configured in askData extension
- #
- # 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.
- (
- AskDataExtension_Filter, :
- AskDataExtensionSortOrder, :
- PermissionMode :
- ): [AskDataExtension]
- # The lens configured in askData extension
- #
- # 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.
- (
- String, :
- Int, :
- Int, :
- AskDataExtension_Filter, :
- AskDataExtensionSortOrder, :
- PermissionMode :
- ): AskDataExtensionsConnection
- # The fields that are upstream of this lens
- #
- # 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.
- (
- Field_Filter, :
- FieldSortOrder, :
- PermissionMode :
- ): [Field]
- # The fields that are upstream of this lens
- #
- # 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.
- (
- String, :
- Int, :
- Int, :
- Field_Filter, :
- FieldSortOrder, :
- PermissionMode :
- ): FieldsConnection
- # The Databases that are upstream to this Lens
- #
- # 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.
- (
- Database_Filter, :
- DatabaseSortOrder, :
- PermissionMode :
- ): [Database]
- # The Databases that are upstream to this Lens
- #
- # 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.
- (
- String, :
- Int, :
- Int, :
- Database_Filter, :
- DatabaseSortOrder, :
- PermissionMode :
- ): DatabasesConnection
- # The datasource that are upstream of this lens
- #
- # 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.
- (
- PublishedDatasource_Filter, :
- PublishedDatasourceSortOrder, :
- PermissionMode :
- ): [PublishedDatasource]
- # The datasource that are upstream of this lens
- #
- # 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.
- (
- String, :
- Int, :
- Int, :
- PublishedDatasource_Filter, :
- PublishedDatasourceSortOrder, :
- PermissionMode :
- ): PublishedDatasourcesConnection
- # The flows that are upstream of this Lens
- #
- # 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.
- (
- Flow_Filter, :
- FlowSortOrder, :
- PermissionMode :
- ): [Flow]
- # The flows that are upstream of this Lens
- #
- # 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.
- (
- String, :
- Int, :
- Int, :
- Flow_Filter, :
- FlowSortOrder, :
- PermissionMode :
- ): FlowsConnection
- # The virtual connection upstream to this Lens
- #
- # 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.
- (
- VirtualConnection_Filter, :
- VirtualConnectionSortOrder, :
- PermissionMode :
- ): [VirtualConnection]
- # The virtual connection upstream to this Lens
- #
- # 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.
- (
- String, :
- Int, :
- Int, :
- VirtualConnection_Filter, :
- VirtualConnectionSortOrder, :
- PermissionMode :
- ): VirtualConnectionsConnection
- # The virtual connection table upstream to this Lens
- #
- # 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.
- (
- VirtualConnectionTable_Filter, :
- VirtualConnectionTableSortOrder, :
- PermissionMode :
- ): [VirtualConnectionTable]
- # The virtual connection table upstream to this Lens
- #
- # 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.
- (
- String, :
- Int, :
- Int, :
- VirtualConnectionTable_Filter, :
- VirtualConnectionTableSortOrder, :
- PermissionMode :
- ): VirtualConnectionTablesConnection
- }
link Require by
- AskDataExtensionAskDataExtensions to base Tableau functionality.
- BinFieldGraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_bins.html
- CalculatedFieldGraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_calculatedfields.html
- CloudFileA cloud file connection
- ColumnGraphQL type for a table column
- ColumnFieldColumnFields are a type of field which directly connects to a column in some type of table.
- CombinedFieldGraphQL type for a combined field. Combined fields concatanate fields together into one string.
- CombinedSetFieldGraphQL type for a combined set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html#Combine
- CustomSQLTableA table that represents the result of evaluating a custom SQL query. These "tables" are owned by the Tableau data source (embedded or published) which contains the SQL query, so they only exist within that data source.
- DashboardA dashboard contained in a published workbook.
- DatabaseA database containing tables
- DatabaseServerA database server connection
- DatabaseTableA table that is contained in a database
- DataCloudA Data Cloud connection *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*
- DatasourceRoot 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
- DatasourceFieldGraphQL 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.
- EmbeddedDatasourceA data source embedded in a workbook
- FieldBase GraphQL type for a field
- FileA file connection
- FlowFlows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.
- FlowColumnOutputFieldColumn output field implementation
- FlowFieldOutputFieldField output field implementation
- FlowOutputFieldA wrapper for an output field contained in a published flow.
- GroupFieldGraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_groups_creating.html
- HierarchyFieldGraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs_hierarchies.html
- LensesConnectionConnection Type for Lens
- LensFieldLens Fields contain extra information based on an underlying datasource field
- MetricMetrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*
- PublishedDatasourceA Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks.
- QueryQuery root for Metadata GraphQL interface
- SetFieldGraphQL type for a set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html
- TableA table containing columns
- TableauSiteSite on Tableau server
- TableauUserUser on a site on Tableau server
- VirtualConnectionA virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*
- VirtualConnectionTableA table in a virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*
- WebDataConnectorA web data connector
- WorkbookWorkbooks 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).