Skip to content
Home Tableau Next, English (United States) Api Api View Partition Index View Full Bundle Download Slice Manifest Guides Documents Authentication : Documentation for the Tableau Cloud Manager
Platform Data : Documentation for the Tableau Cloud Manager
Tableau Cloud Manager (TCM) Release Notes : Documentation for the Tableau Cloud Manager
Tableau Cloud Manager Operation Error Codes : Documentation for the Tableau Cloud Manager
How to Get Tenant Name : Documentation for the Tableau Cloud Manager
Unified Access Tokens : Documentation for the Tableau Cloud Manager
Tableau Cloud Manager REST API Overview : Documentation for the Tableau Cloud Manager
Tableau Cloud Manager REST API Reference
About the Embedding API v3 : Documentation for the Tableau Embedding API
Embed Ask Data : Documentation for the Tableau Embedding API
Authentication and Embedding : Documentation for the Tableau Embedding API
Basic Embedding : Documentation for the Tableau Embedding API
Configure Embedding Objects and Components : Documentation for the Tableau Embedding API
Add Custom Context Menus : Documentation for the Tableau Embedding API
Embed Custom Views : Documentation for the Tableau Embedding API
Get Data From Embedded Views : Documentation for the Tableau Embedding API
Add Event Listeners to the Embedded Tableau View : Documentation for the Tableau Embedding API
Export Embedded Views : Documentation for the Tableau Embedding API
Filter the View : Documentation for the Tableau Embedding API
Access Tableau Embedding API v3 : Documentation for the Tableau Embedding API
Interact with the View : Documentation for the Tableau Embedding API
Known Issues for the Embedding API v3 : Documentation for the Tableau Embedding API
Upgrade from Tableau JavaScript API v1 and v2 : Documentation for the Tableau Embedding API
Embed New Empty Workbook on Tableau : Documentation for the Tableau Embedding API
Use Parameters in Embedded Views : Documentation for the Tableau Embedding API
Embed Tableau Pulse : Documentation for the Tableau Embedding API
Add Event Listeners to Tableau Pulse : Documentation for the Tableau Embedding API
Filter Tableau Pulse Metrics : Documentation for the Tableau Embedding API
Format and Customize Tableau Pulse : Documentation for the Tableau Embedding API
Using Tableau Embedding API React Components : Documentation for the Tableau Embedding API
Release Notes for the Tableau Embedding API : Documentation for the Tableau Embedding API
Select Marks in the View : Documentation for the Tableau Embedding API
Tableau Site Settings for Embedding : Documentation for the Tableau Embedding API
About Tableau Help : Documentation for the Tableau Embedding API
Troubleshooting and Debugging : Documentation for the Tableau Embedding API
Customize and Control Data Access : Documentation for the Tableau Embedding API
Embed Tableau Web Authoring : Documentation for the Tableau Embedding API
Tableau Embedding API v3 : Documentation for the Tableau Embedding API
AnalyticsObjectType | Tableau Embedding API : Documentation for Tableau Embedding API
AnnotationType | Tableau Embedding API : Documentation for Tableau Embedding API
ApiMenuType | Tableau Embedding API : Documentation for Tableau Embedding API
ClassNameKey | Tableau Embedding API : Documentation for Tableau Embedding API
ColumnType | Tableau Embedding API : Documentation for Tableau Embedding API
CrosstabFileFormat | Tableau Embedding API : Documentation for Tableau Embedding API
DashboardLayoutChange | Tableau Embedding API : Documentation for Tableau Embedding API
DashboardObjectType | Tableau Embedding API : Documentation for Tableau Embedding API
DashboardObjectVisibilityType | Tableau Embedding API : Documentation for Tableau Embedding API
DataFormatType | Tableau Embedding API : Documentation for Tableau Embedding API
DataType | Tableau Embedding API : Documentation for Tableau Embedding API
DateRangeType | Tableau Embedding API : Documentation for Tableau Embedding API
DeviceType | Tableau Embedding API : Documentation for Tableau Embedding API
DialogStyle | Tableau Embedding API : Documentation for Tableau Embedding API
EmbeddingErrorCodes | Tableau Embedding API : Documentation for Tableau Embedding API
EncodingType | Tableau Embedding API : Documentation for Tableau Embedding API
FieldAggregationType | Tableau Embedding API : Documentation for Tableau Embedding API
FieldRoleType | Tableau Embedding API : Documentation for Tableau Embedding API
FilterDomainType | Tableau Embedding API : Documentation for Tableau Embedding API
FilterNullOption | Tableau Embedding API : Documentation for Tableau Embedding API
FilterType | Tableau Embedding API : Documentation for Tableau Embedding API
FilterUpdateType | Tableau Embedding API : Documentation for Tableau Embedding API
HierarchicalLevelSelectionState | Tableau Embedding API : Documentation for Tableau Embedding API
IncludeDataValuesOption | Tableau Embedding API : Documentation for Tableau Embedding API
MarkType | Tableau Embedding API : Documentation for Tableau Embedding API
NegativeNumberFormat | Tableau Embedding API : Documentation for Tableau Embedding API
NumberFormatUnits | Tableau Embedding API : Documentation for Tableau Embedding API
ParameterValueType | Tableau Embedding API : Documentation for Tableau Embedding API
PeriodType | Tableau Embedding API : Documentation for Tableau Embedding API
PrintOrientation | Tableau Embedding API : Documentation for Tableau Embedding API
PrintPageSize | Tableau Embedding API : Documentation for Tableau Embedding API
PrintScaling | Tableau Embedding API : Documentation for Tableau Embedding API
PulseChildElementAttributes | Tableau Embedding API : Documentation for Tableau Embedding API
PulseChildElements | Tableau Embedding API : Documentation for Tableau Embedding API
PulseErrorMessageVisibility | Tableau Embedding API : Documentation for Tableau Embedding API
PulseLayout | Tableau Embedding API : Documentation for Tableau Embedding API
PulseTimeDimension | Tableau Embedding API : Documentation for Tableau Embedding API
QuickTableCalcType | Tableau Embedding API : Documentation for Tableau Embedding API
ReplaySpeedType | Tableau Embedding API : Documentation for Tableau Embedding API
SelectOptions | Tableau Embedding API : Documentation for Tableau Embedding API
SelectionUpdateType | Tableau Embedding API : Documentation for Tableau Embedding API
SharedErrorCodes | Tableau Embedding API : Documentation for Tableau Embedding API
SheetSizeBehavior | Tableau Embedding API : Documentation for Tableau Embedding API
SheetType | Tableau Embedding API : Documentation for Tableau Embedding API
SortDirection | Tableau Embedding API : Documentation for Tableau Embedding API
TableauDialogType | Tableau Embedding API : Documentation for Tableau Embedding API
TableauEventType | Tableau Embedding API : Documentation for Tableau Embedding API
Toolbar | Tableau Embedding API : Documentation for Tableau Embedding API
TrendLineModelType | Tableau Embedding API : Documentation for Tableau Embedding API
VizChildElementAttributes | Tableau Embedding API : Documentation for Tableau Embedding API
VizChildElements | Tableau Embedding API : Documentation for Tableau Embedding API
WebComponentChildElementAttributes | Tableau Embedding API : Documentation for Tableau Embedding API
Tableau Embedding API : Documentation for Tableau Embedding API
Tableau Embedding API : Documentation for Tableau Embedding API
Annotation | Tableau Embedding API : Documentation for Tableau Embedding API
AskData | Tableau Embedding API : Documentation for Tableau Embedding API
AskDataSettings | Tableau Embedding API : Documentation for Tableau Embedding API
AuthoringViz | Tableau Embedding API : Documentation for Tableau Embedding API
CategoricalDomain | Tableau Embedding API : Documentation for Tableau Embedding API
CategoricalFilter | Tableau Embedding API : Documentation for Tableau Embedding API
CategoricalPulseFilter | Tableau Embedding API : Documentation for Tableau Embedding API
Column | Tableau Embedding API : Documentation for Tableau Embedding API
ConnectionSummary | Tableau Embedding API : Documentation for Tableau Embedding API
ContextMenuOptions | Tableau Embedding API : Documentation for Tableau Embedding API
CustomMarkContextMenuEvent | Tableau Embedding API : Documentation for Tableau Embedding API
CustomParameter | Tableau Embedding API : Documentation for Tableau Embedding API
CustomView | Tableau Embedding API : Documentation for Tableau Embedding API
CustomViewEvent | Tableau Embedding API : Documentation for Tableau Embedding API
Dashboard | Tableau Embedding API : Documentation for Tableau Embedding API
DashboardObject | Tableau Embedding API : Documentation for Tableau Embedding API
DataFormattingOptions | Tableau Embedding API : Documentation for Tableau Embedding API
DataSource | Tableau Embedding API : Documentation for Tableau Embedding API
DataSourceUnderlyingDataOptions | Tableau Embedding API : Documentation for Tableau Embedding API
DataTable | Tableau Embedding API : Documentation for Tableau Embedding API
DataTableReader | Tableau Embedding API : Documentation for Tableau Embedding API
DataValue | Tableau Embedding API : Documentation for Tableau Embedding API
Encoding | Tableau Embedding API : Documentation for Tableau Embedding API
ExportDataOptions | Tableau Embedding API : Documentation for Tableau Embedding API
ExportPDFOptions | Tableau Embedding API : Documentation for Tableau Embedding API
ExportScenariosForPDFAndPowerPoint | Tableau Embedding API : Documentation for Tableau Embedding API
Field | Tableau Embedding API : Documentation for Tableau Embedding API
FieldInstance | Tableau Embedding API : Documentation for Tableau Embedding API
Filter | Tableau Embedding API : Documentation for Tableau Embedding API
FilterChangedEvent | Tableau Embedding API : Documentation for Tableau Embedding API
FilterOptions | Tableau Embedding API : Documentation for Tableau Embedding API
FilterParameters | Tableau Embedding API : Documentation for Tableau Embedding API
FirstPulseMetricSizeKnownEvent | Tableau Embedding API : Documentation for Tableau Embedding API
FirstVizSizeKnownEvent | Tableau Embedding API : Documentation for Tableau Embedding API
FormattingSheet | Tableau Embedding API : Documentation for Tableau Embedding API
GetSummaryDataOptions | Tableau Embedding API : Documentation for Tableau Embedding API
GetUnderlyingDataOptions | Tableau Embedding API : Documentation for Tableau Embedding API
HierarchicalFilter | Tableau Embedding API : Documentation for Tableau Embedding API
HierarchicalFilterDataValue | Tableau Embedding API : Documentation for Tableau Embedding API
HierarchicalLevelDetail | Tableau Embedding API : Documentation for Tableau Embedding API
HierarchicalLevels | Tableau Embedding API : Documentation for Tableau Embedding API
LogicalTable | Tableau Embedding API : Documentation for Tableau Embedding API
MarkInfo | Tableau Embedding API : Documentation for Tableau Embedding API
MarksCollection | Tableau Embedding API : Documentation for Tableau Embedding API
MarksSelectedEvent | Tableau Embedding API : Documentation for Tableau Embedding API
MarksSpecification | Tableau Embedding API : Documentation for Tableau Embedding API
Parameter | Tableau Embedding API : Documentation for Tableau Embedding API
ParameterChangedEvent | Tableau Embedding API : Documentation for Tableau Embedding API
ParameterDomainRestriction | Tableau Embedding API : Documentation for Tableau Embedding API
Point | Tableau Embedding API : Documentation for Tableau Embedding API
Pulse | Tableau Embedding API : Documentation for Tableau Embedding API
PulseActions | Tableau Embedding API : Documentation for Tableau Embedding API
PulseCategoricalDomain | Tableau Embedding API : Documentation for Tableau Embedding API
PulseErrorEvent | Tableau Embedding API : Documentation for Tableau Embedding API
PulseFilter | Tableau Embedding API : Documentation for Tableau Embedding API
PulseFiltersChangedEvent | Tableau Embedding API : Documentation for Tableau Embedding API
PulseInsightDiscoveredEvent | Tableau Embedding API : Documentation for Tableau Embedding API
PulseSettings | Tableau Embedding API : Documentation for Tableau Embedding API
PulseThemeProperty | Tableau Embedding API : Documentation for Tableau Embedding API
PulseTimeDimensionChangedEvent | Tableau Embedding API : Documentation for Tableau Embedding API
PulseUrlChangedEvent | Tableau Embedding API : Documentation for Tableau Embedding API
RangeDomain | Tableau Embedding API : Documentation for Tableau Embedding API
RangeFilter | Tableau Embedding API : Documentation for Tableau Embedding API
RangeFilterOptions | Tableau Embedding API : Documentation for Tableau Embedding API
RangeValue | Tableau Embedding API : Documentation for Tableau Embedding API
RelativeDateFilter | Tableau Embedding API : Documentation for Tableau Embedding API
RelativeDateFilterOptions | Tableau Embedding API : Documentation for Tableau Embedding API
SelectionCriteria | Tableau Embedding API : Documentation for Tableau Embedding API
Sheet | Tableau Embedding API : Documentation for Tableau Embedding API
SheetInfo | Tableau Embedding API : Documentation for Tableau Embedding API
SheetSize | Tableau Embedding API : Documentation for Tableau Embedding API
Size | Tableau Embedding API : Documentation for Tableau Embedding API
Story | Tableau Embedding API : Documentation for Tableau Embedding API
StoryPoint | Tableau Embedding API : Documentation for Tableau Embedding API
StoryPointInfo | Tableau Embedding API : Documentation for Tableau Embedding API
StoryPointSwitchedEvent | Tableau Embedding API : Documentation for Tableau Embedding API
SummaryDataChangedEvent | Tableau Embedding API : Documentation for Tableau Embedding API
TabSwitchedEvent | Tableau Embedding API : Documentation for Tableau Embedding API
TableSummary | Tableau Embedding API : Documentation for Tableau Embedding API
TableauEmbeddingError | Tableau Embedding API : Documentation for Tableau Embedding API
TableauSheetEvent | Tableau Embedding API : Documentation for Tableau Embedding API
TableauWorksheetEvent | Tableau Embedding API : Documentation for Tableau Embedding API
ToolbarStateChangedEvent | Tableau Embedding API : Documentation for Tableau Embedding API
UrlActionEvent | Tableau Embedding API : Documentation for Tableau Embedding API
VisualSpecification | Tableau Embedding API : Documentation for Tableau Embedding API
Viz | Tableau Embedding API : Documentation for Tableau Embedding API
VizActions | Tableau Embedding API : Documentation for Tableau Embedding API
VizAuthoringSettings | Tableau Embedding API : Documentation for Tableau Embedding API
VizLoadErrorEvent | Tableau Embedding API : Documentation for Tableau Embedding API
VizParameter | Tableau Embedding API : Documentation for Tableau Embedding API
VizQLDataServiceSessionInfo | Tableau Embedding API : Documentation for Tableau Embedding API
VizSettings | Tableau Embedding API : Documentation for Tableau Embedding API
VizSize | Tableau Embedding API : Documentation for Tableau Embedding API
WebComponentLocalSettings | Tableau Embedding API : Documentation for Tableau Embedding API
WebComponentSettingsShared | Tableau Embedding API : Documentation for Tableau Embedding API
Workbook | Tableau Embedding API : Documentation for Tableau Embedding API
WorkbookFormatting | Tableau Embedding API : Documentation for Tableau Embedding API
WorkbookPublishedAsEvent | Tableau Embedding API : Documentation for Tableau Embedding API
Worksheet | Tableau Embedding API : Documentation for Tableau Embedding API
WorksheetFormatting | Tableau Embedding API : Documentation for Tableau Embedding API
Tableau Embedding API : Documentation for Tableau Embedding API
CategoricalValue | Tableau Embedding API : Documentation for Tableau Embedding API
DataFormat | Tableau Embedding API : Documentation for Tableau Embedding API
PulseFieldValueArray | Tableau Embedding API : Documentation for Tableau Embedding API
PulseTheme | Tableau Embedding API : Documentation for Tableau Embedding API
ZoneVisibilityType | Tableau Embedding API : Documentation for Tableau Embedding API
ZoneVisibilityType | Tableau Embedding API : Documentation for Tableau Embedding API
Embedding API v3 Tutorial
Bash Example : Documentation for the Explore in Tableau API
cURL Example : Documentation for the Explore in Tableau API
Java Example : Documentation for the Explore in Tableau API
Python example : Documentation for the Explore in Tableau API
Response Example : Documentation for the Explore in Tableau API
Examples : Documentation for the Explore in Tableau API
Using the API : Documentation for the Explore in Tableau API
What's New : Documentation for the Explore in Tableau API
Explore in Tableau API Overview : Documentation for the Explore in Tableau API
About Tableau Help : In an effort to align with one of our core company values, equality, we have changed terminology to be more inclusive where possible
Tableau JavaScript API : Important changes for the Tableau JavaScript API As of February 2024, the Tableau JavaScript API is deprecated
Concepts : Important changes for the Tableau JavaScript API
Tableau JavaScript API Concepts--Asynchronous Calls : Important changes for the Tableau JavaScript API
Tableau JavaScript API Concepts--Authentication : Important changes for the Tableau JavaScript API
Tableau JavaScript API Concepts--Collections : Important changes for the Tableau JavaScript API
Tableau JavaScript API Concepts--Events : Important changes for the Tableau JavaScript API
Tableau JavaScript API Concepts--Filtering : Important changes for the Tableau JavaScript API
Tableau JavaScript API Concepts--Accessing the API : Important changes for the Tableau JavaScript API
Tableau JavaScript API Concepts--Initializing the API : Important changes for the Tableau JavaScript API
Tableau JavaScript API Concepts--Property Getters and Setters : Important changes for the Tableau JavaScript API
Tableau JavaScript API Concepts--Selecting Marks : Important changes for the Tableau JavaScript API
API Reference : Important changes for the Tableau JavaScript API
Requirements : Important changes for the Tableau JavaScript API
Basic Embed : Important changes for the Tableau JavaScript API
Dynamic Load : Important changes for the Tableau JavaScript API
Export to PDF : Important changes for the Tableau JavaScript API
Filter : Important changes for the Tableau JavaScript API
Resize : Important changes for the Tableau JavaScript API
Respond to Events : Important changes for the Tableau JavaScript API
Select Marks : Important changes for the Tableau JavaScript API
Samples : Important changes for the Tableau JavaScript API
Get Data : Important changes for the Tableau JavaScript API
Third Party Demos : Important changes for the Tableau JavaScript API
Tableau JavaScript API Concepts--What's New : Important changes for the Tableau JavaScript API
Tableau Help
How to Authenticate : Documentation for the Tableau Metadata API
Core Concepts and Definitions : Documentation for the Tableau Metadata API
Connection Types : Documentation for the Tableau Metadata API
Common Errors : Documentation for the Tableau Metadata API
Example Queries : Documentation for the Tableau Metadata API
About Tableau Help : Documentation for the Tableau Metadata API
Understand the Metadata Model : Documentation for the Tableau Metadata API
How Permissions Work : Documentation for the Tableau Metadata API
Release Notes : Documentation for the Tableau Metadata API
Sample Scripts : Documentation for the Tableau Metadata API
Get Started : Documentation for the Tableau Metadata API
Introduction to Tableau Metadata API : Documentation for the Tableau Metadata API
AnalyticsField
AnalyticsField_Filter
AnalyticsFieldOrderField
AnalyticsFieldsConnection
AnalyticsFieldSortOrder
AskDataExtension
AskDataExtension_Filter
AskDataExtension_Required_Filter
AskDataExtensionOrderField
AskDataExtensionsConnection
AskDataExtensionSortOrder
BinField
BinField_Filter
BinField_Required_Filter
BinFieldOrderField
BinFieldsConnection
BinFieldSortOrder
Boolean
CalculatedField
CalculatedField_Filter
CalculatedField_Required_Filter
CalculatedFieldOrderField
CalculatedFieldsConnection
CalculatedFieldSortOrder
CanHaveLabels
CanHaveLabels_Filter
CanHaveLabelsesConnection
CanHaveLabelsOrderField
CanHaveLabelsSortOrder
Certifiable
Certifiable_Filter
CertifiableOrderField
CertifiablesConnection
CertifiableSortOrder
CloudFile
CloudFile_Filter
CloudFileOrderField
CloudFilesConnection
CloudFileSortOrder
Column
Column_Filter
Column_Required_Filter
ColumnField
ColumnField_Filter
ColumnField_Required_Filter
ColumnFieldOrderField
ColumnFieldsConnection
ColumnFieldSortOrder
ColumnOrderField
ColumnsConnection
ColumnSortOrder
CombinedField
CombinedField_Filter
CombinedField_Required_Filter
CombinedFieldOrderField
CombinedFieldsConnection
CombinedFieldSortOrder
CombinedSetField
CombinedSetField_Filter
CombinedSetField_Required_Filter
CombinedSetFieldOrderField
CombinedSetFieldsConnection
CombinedSetFieldSortOrder
CustomSQLTable
CustomSQLTable_Filter
CustomSQLTableOrderField
CustomSQLTablesConnection
CustomSQLTableSortOrder
Dashboard
Dashboard_Filter
DashboardOrderField
DashboardsConnection
DashboardSortOrder
Database
Database_Filter
DatabaseOrderField
DatabasesConnection
DatabaseServer
DatabaseServer_Filter
DatabaseServerOrderField
DatabaseServersConnection
DatabaseServerSortOrder
DatabaseSortOrder
DatabaseTable
DatabaseTable_Filter
DatabaseTableOrderField
DatabaseTablesConnection
DatabaseTableSortOrder
DataCloud
DataCloud_Filter
DataCloudOrderField
DataCloudsConnection
DataCloudSortOrder
DataField
DataField_Filter
DataFieldOrderField
DataFieldsConnection
DataFieldSortOrder
DataQualityCertification
DataQualityCertification_Filter
DataQualityCertificationOrderField
DataQualityCertificationsConnection
DataQualityCertificationSortOrder
DataQualityWarning
DataQualityWarning_Filter
DataQualityWarningOrderField
DataQualityWarningsConnection
DataQualityWarningSortOrder
Datasource
Datasource_Filter
DatasourceField
DatasourceField_Filter
DatasourceField_Required_Filter
DatasourceFieldOrderField
DatasourceFieldsConnection
DatasourceFieldSortOrder
DatasourceFilter
DatasourceFilter_Filter
DatasourceFilterOrderField
DatasourceFiltersConnection
DatasourceFilterSortOrder
DatasourceOrderField
DatasourcesConnection
DatasourceSortOrder
DateTime
deprecated
__Directive
__DirectiveLocation
EmbeddedDatasource
EmbeddedDatasource_Filter
EmbeddedDatasourceOrderField
EmbeddedDatasourcesConnection
EmbeddedDatasourceSortOrder
__EnumValue
ExtractType
ExtractType_Filter
Field
__Field
Field_Filter
Field_Required_Filter
FieldDataType
FieldDataType_Filter
FieldOrderField
FieldReferencingField
FieldReferencingField_Filter
FieldReferencingFieldOrderField
FieldReferencingFieldsConnection
FieldReferencingFieldSortOrder
FieldRole
FieldRole_Filter
FieldRoleCategory
FieldRoleCategory_Filter
FieldsConnection
FieldSortOrder
File
File_Filter
FileOrderField
FilesConnection
FileSortOrder
Flow
Flow_Filter
FlowColumnInputField
FlowColumnInputField_Filter
FlowColumnInputFieldOrderField
FlowColumnInputFieldsConnection
FlowColumnInputFieldSortOrder
FlowColumnOutputField
FlowColumnOutputField_Filter
FlowColumnOutputFieldOrderField
FlowColumnOutputFieldsConnection
FlowColumnOutputFieldSortOrder
FlowFieldInputField
FlowFieldInputField_Filter
FlowFieldInputFieldOrderField
FlowFieldInputFieldsConnection
FlowFieldInputFieldSortOrder
FlowFieldOutputField
FlowFieldOutputField_Filter
FlowFieldOutputFieldOrderField
FlowFieldOutputFieldsConnection
FlowFieldOutputFieldSortOrder
FlowInputField
FlowInputField_Filter
FlowInputFieldOrderField
FlowInputFieldsConnection
FlowInputFieldSortOrder
FlowOrderField
FlowOutputField
FlowOutputField_Filter
FlowOutputFieldOrderField
FlowOutputFieldsConnection
FlowOutputFieldSortOrder
FlowOutputStep
FlowOutputStep_Filter
FlowOutputStepOrderField
FlowOutputStepsConnection
FlowOutputStepSortOrder
FlowsConnection
FlowSortOrder
GenericLabel
GenericLabel_Filter
GenericLabelOrderField
GenericLabelsConnection
GenericLabelSortOrder
GroupField
GroupField_Filter
GroupField_Required_Filter
GroupFieldOrderField
GroupFieldsConnection
GroupFieldSortOrder
HierarchyField
HierarchyField_Filter
HierarchyField_Required_Filter
HierarchyFieldOrderField
HierarchyFieldsConnection
HierarchyFieldSortOrder
ID
include
Graphql schema documentation
InheritanceType
InheritedStringResult
__InputValue
Int
Label
Label_Filter
LabelOrderField
LabelsConnection
LabelSortOrder
Lens
Lens_Filter
LensesConnection
LensField
LensField_Filter
LensField_Required_Filter
LensFieldOrderField
LensFieldsConnection
LensFieldSortOrder
LensOrderField
LensSortOrder
LinkedFlow
LinkedFlow_Filter
LinkedFlowOrderField
LinkedFlowsConnection
LinkedFlowSortOrder
Metric
Metric_Filter
MetricDefinition
MetricDefinition_Filter
MetricDefinitionOrderField
MetricDefinitionsConnection
MetricDefinitionSortOrder
MetricOrderField
MetricsConnection
MetricSortOrder
Node
Node_Filter
NodeOrderField
NodesConnection
NodeSortOrder
OrderDirection
PageInfo
Parameter
Parameter_Filter
ParameterOrderField
ParametersConnection
ParameterSortOrder
PermissionMode
PublishedDatasource
PublishedDatasource_Filter
PublishedDatasourceOrderField
PublishedDatasourcesConnection
PublishedDatasourceSortOrder
Query
RemoteType
RemoteType_Filter
__Schema
SetField
SetField_Filter
SetField_Required_Filter
SetFieldOrderField
SetFieldsConnection
SetFieldSortOrder
Sheet
Sheet_Filter
SheetOrderField
SheetsConnection
SheetSortOrder
skip
specifiedBy
String
Table
Table_Filter
TableAdditionalDetails
TableAdditionalDetails_Filter
TableAdditionalDetailsesConnection
TableAdditionalDetailsOrderField
TableAdditionalDetailsSortOrder
TableauSite
TableauSite_Filter
TableauSiteOrderField
TableauSitesConnection
TableauSiteSortOrder
TableauUser
TableauUser_Filter
TableauUserOrderField
TableauUsersConnection
TableauUserSortOrder
TableOrderField
TablesConnection
TableSortOrder
TableType
TableType_Filter
Tag
Tag_Filter
Taggable
Taggable_Filter
TaggableOrderField
TaggablesConnection
TaggableSortOrder
TagOrderField
TagsConnection
TagSortOrder
__Type
__TypeKind
View
View_Filter
ViewOrderField
ViewsConnection
ViewSortOrder
VirtualConnection
VirtualConnection_Filter
VirtualConnectionOrderField
VirtualConnectionsConnection
VirtualConnectionSortOrder
VirtualConnectionTable
VirtualConnectionTable_Filter
VirtualConnectionTableOrderField
VirtualConnectionTablesConnection
VirtualConnectionTableSortOrder
Warnable
Warnable_Filter
WarnableOrderField
WarnablesConnection
WarnableSortOrder
WebDataConnector
WebDataConnector_Filter
WebDataConnectorOrderField
WebDataConnectorsConnection
WebDataConnectorSortOrder
Workbook
Workbook_Filter
WorkbookOrderField
WorkbooksConnection
WorkbookSortOrder
Authentication : Documentation for the Tableau Migration Guide
Tableau Migration Guide Overview : Documentation for the Tableau Migration Guide
Architecture : Documentation for the Tableau Migration SDK
Best Practices : Documentation for the Tableau Migration SDK
Concepts : Documentation for the Tableau Migration SDK
Design Your Migration Application : Documentation for the Tableau Migration SDK
Writing a .NET Application : Documentation for the Tableau Migration SDK
About Tableau Help : Documentation for the Tableau Migration SDK
Pre-Migration Checklist : Documentation for the Tableau Migration SDK
Install the Migration SDK : Documentation for the Tableau Migration SDK
Migration Tasks : Documentation for the Tableau Migration SDK
Tableau Migration SDK Overview : Documentation for the Tableau Migration SDK
Plan Your Migration : Documentation for the Tableau Migration SDK
Complete Post-Migration Tasks : Documentation for the Tableau Migration SDK
Writing a Python Application : Documentation for the Tableau Migration SDK
Download Custom View : Documentation for the Tableau Migration SDK
Publish Custom View : Documentation for the Tableau Migration SDK
Run Your Migration : Documentation for the Tableau Migration SDK
SDK Reference : Documentation for the Tableau Migration SDK
Supported Content Types : Documentation for the Tableau Migration SDK
Troubleshooting : Documentation for the Tableau Migration SDK
What's New : Documentation for the Tableau Migration SDK
Tableau Migration SDK Overview : Documentation for the Tableau Migration SDK
Tableau REST API OpenAPI Endpoints
About Tableau Help : In an effort to align with one of our core company values, equality, we have changed terminology to be more inclusive where possible
Tableau Server REST API : With the Tableau Server REST API you can manage and change Tableau Server, Tableau Cloud site, and Prep Conductor resources programmatically, using HTTP
Concepts-Tableau Server REST API : This section provides background information about how to use the Tableau Server REST API and how it works
Using SSL-Tableau Server REST API : As a security measure, you should make API calls to Tableau Server using the HTTPS protocol (SSL or TLS)—that is, using an encrypted channel between your client and Tableau Server
Authentication-Tableau Server REST API : The Tableau REST API requires that you send a credentials token with each request
Mapping ConnectionType Names : Using the Tableau Server REST API, you can access connection information used by data sources, workbooks, and flows
Data Acceleration : Important changes for Tableau View Acceleration and Data Acceleration Tableau's View Acceleration feature and Data Acceleration APIs are retired
Data Labels in the REST API : Data Labels, described in the "Data Labels" topic of the Tableau Cloud and Tableau Server help, can be extensively controlled through the REST API
Handling Errors-Tableau Server REST API : If a request results in an error, the server returns an HTTP status code that indicates the general nature of the error
REST API Example Requests : This topic illustrates the structure of REST API requests by showing the raw HTTP, including both headers and the body (as appropriate)
Using Fields in the REST API : You can control the type and amount of data that gets returned from requests to the following REST API endpoints:
Filtering and Sorting in the Tableau REST API : You can filter and sort the data that gets returned from requests to the following REST API endpoints:
Fundamentals-Tableau Server REST API : Tableau Server provides an application programming interface (API) that lets you programmatically manage users, workbooks, data connections, and other resources on the server
Identifying Resources Using LUIDs-Tableau Server REST API : Resources on Tableau Server typically have a friendly name, such as "Default" for a site name, "Developers" for a group, and "Adam" for a user
Updated Site Roles in REST API 3.0 and Later : Starting with the 2018
Paging Results-Tableau Server REST API : REST API methods that might return a large number of individual elements support pagination
Permissions-Tableau Server REST API : Users who call REST API methods must have permission to perform the task represented by each method that they call
Publishing Resources-Tableau Server REST API : You can use the REST API to programmatically publish (upload) workbooks and data sources to the server
Using Pulse Generate Insight Brief : This topic provides supplemental information about how to use the Generate insight brief REST API to make the most of the Enhanced Q&A (Discover) features of the Tableau AI stack
XML Schema-Tableau Server REST API : REST API methods that require data in the body of the request pass the data as an XML block
Testing-Tableau Server REST API : Usually, you make REST API calls to Tableau Server by writing a program in Python, Ruby, Java, C#, or other programming language that supports HTTP requests
REST API and Resource Versions : Classic REST endpoints: The more than 150 REST endpoints that let you programmatically take many of the actions available in the user interface of Tableau Cloud, on-premise Tableau Server, Tableau Prep and more
Get Started Tutorial: Introduction and Set Up : This is the introduction to a 3-part tutorial on the basics of using the Tableau Server REST API to manage your resources
Get Started Tutorial Part 1: Tools, REST Basics, and Sign In : This is part 1 of a 3-part tutorial to help you get started using the Tableau Server REST API
Get Started Tutorial Part 2: Create a Project and Publish a Workbook to it : This is Part 2 of a 3-part tutorial to help you get started using the Tableau Server REST API
Get Started Tutorial Part 3: Create a User Group and Give it Permissions : This is part 3 of a 3-part tutorial to help you get started using the Tableau Server REST API
Understand Workbook Impact on Your Database Using Query Tagging : Query tagging enables Tableau Server administrators to trace the specific Tableau activity that sends queries to their databases
Update Data in Published Live-to-Hyper Data Sources : You can modify (insert, update, upsert, replace, and delete) data in a published data source that has a live-to-Hyper connection
Reference-Tableau Server REST API : Using the Tableau Server REST API, you can manage and change Tableau Server resources programmatically, via HTTP
Analytics Extensions Settings Methods : Enable and configure analytics extensions on sites and, for on premise installations, on servers
Ask Data Lens Methods - Retired : Important changes for Ask Data and Metrics Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024
Authentication Methods : Using the authentication methods of the Tableau REST API you can:
Bridge Methods : Using the Bridge methods of the Tableau REST API you can:
Collections Methods : Collections REST API endpoints enable you to retrieve and manipulate Tableau collections programmatically
Connected App Methods : Connected app-specific methods were introduced in Tableau 2021
Content Exploration Methods : Content exploration methods enable you to view:
Custom Domain Methods : Custom domains allow your Tableau Cloud site to use a subdomain of your top level domain
Dashboard Extensions Settings Methods - Retired : In October 2023 Tableau Cloud and Tableau Server version 2023
Data Sources Methods : Using the data sources methods of the Tableau Server REST API you can:
Extract and Encryption Methods : Extracts are saved subsets of data that you can use to improve performance, or to take advantage of Tableau functionality not available or supported in your original data)
Favorites Methods : Using the favorites methods of the Tableau Server REST API you can:
Flow Methods : Using the flow methods of the Tableau Server REST API you can do the operations listed in the following categories:
Identity Pools Methods : Identity pools are an identity management tool that uses provisioning and authentication information to enable user access to Tableau Server
Jobs, Tasks, and Schedules Methods : Using the jobs, tasks, and schedules methods of the Tableau Server REST API you can do the operations listed in the following categories:
Metadata Methods : Metadata methods have been released incrementally beginning with Tableau version 2019
Metrics Methods - Retired : Retired in API 3
Mobile Settings Methods : Using the mobile settings methods of the Tableau REST API you can:
Notifications Methods : Notification methods consists of data-driven alerts, user notification preferences, and webhooks
OpenID Connect Methods : Using the OpenID Connect (OIDC) methods of the Tableau REST API you can:
Permissions Methods : Using the permissions methods of the Tableau REST API you can:
Projects Methods : Projects are sets of workbooks, data sources, and flows whose members inherit the project's permissions
Publishing Methods : Using the publishing methods of the Tableau Server REST API you can:
Pulse Methods : With Tableau Pulse, Tableau Cloud users can follow metrics and use guided exploration to understand more about their data
Recycle Bin Methods : The Recycle Bin methods of the Tableau REST API allow you to manage Recycle Bin content on your site
Revisions Methods : Using the revisions methods of the Tableau Server REST API you can:
Server Methods : Using the server method of the Tableau Server REST API you can:
Site Methods : Using the site methods of the Tableau Server REST API you can:
Subscriptions Methods : Using the subscriptions methods of the Tableau Server REST API you can do the operations listed in the following category:
Tableau Extensions Settings Methods : Tableau extensions settings control which dashboard extensions are allowed to run on a Tableau Server, and on a site on Server or Cloud
Tableau Knowledge Graph Methods : Read and write the per-site Tableau Knowledge Graph
Tableau MCP Methods : Using the Tableau MCP methods of the REST API you can:
Users and Groups Methods : Using the groups and users methods of the Tableau REST API you can do the operations listed in the following categories:
Virtual Connections Methods : Virtual connections are a centralized way to share access to databases and tables, allowing for convenient reuse
Workbooks and Views Methods : Using the workbooks and views methods of the Tableau Server REST API you can do the operations listed in the following categories:
Requirements-Tableau Server REST API : The REST API is permanently enabled for Tableau Cloud
Samples-Tableau Server REST API : To help you use the REST API, Tableau provides samples written in Python and in Java
What's New-Tableau Server REST API : This topic summarizes changes made to the REST API for Tableau Server and Tableau Cloud
Tableau Help
About Tableau Help : Documentation for the Tableau SCIM API
SCIM API Authentication : Documentation for the Tableau SCIM API
SCIM API Groups Methods : Documentation for the Tableau SCIM API
SCIM API Users Methods : Documentation for the Tableau SCIM API
What's New : Documentation for the Tableau SCIM API
Tableau SCIM API : Documentation for the Tableau SCIM API
Get Started : Documentation for the Tableau Studio API Reference
Troubleshooting : Documentation for the Tableau Studio API Reference
Tableau Studio API Reference : Documentation for the Tableau Studio API Reference
Downloading call-studio-api.py
External Client API (PRE-RELEASE - confidential)
Customize Expertise : Developer documentation for Tableau Studio
Customize Skills : Developer documentation for Tableau Studio
Customize Tableau Agent : Developer documentation for Tableau Studio
Get Started with Tableau Agent : Developer documentation for Tableau Studio
Tableau Studio Developer Guide : Developer documentation for Tableau Studio
References and Guides : Developer documentation for Tableau Studio
Release Notes : Developer documentation for Tableau Studio
Tableau Studio Basics : Developer documentation for Tableau Studio
Troubleshooting : Developer documentation for Tableau Studio
Use Tableau Studio Headless : Developer documentation for Tableau Studio
Authentication : Documentation for Tableau Services Manager API
Test with Postman : Documentation for Tableau Services Manager API
Samples : Documentation for Tableau Services Manager API
Search : Documentation for Tableau Services Manager API
TSM API Reference : Documentation for Tableau Services Manager API
Tableau Services Manager API : Documentation for Tableau Services Manager API
About Tableau Help : Documentation for the VizQL Data Service
Configuration : Documentation for the VizQL Data Service
Query a Data Source : Documentation for the VizQL Data Service
Use VDS with an Embedded Tableau Viz : Documentation for the VizQL Data Service
Error Codes : Documentation for the VizQL Data Service
Request Data Source Metadata : Documentation for the VizQL Data Service
Get Data Source Model : Documentation for the VizQL Data Service
Limitations : Documentation for the VizQL Data Service
VizQL OpenAPI Schema : Documentation for the VizQL Data Service
Custom Table Calculations : Documentation for the VizQL Data Service
Table Calculation Query Examples : Documentation for the VizQL Data Service
Nested Table Calculations : Documentation for the VizQL Data Service
Table Calculations Overview : Documentation for the VizQL Data Service
Table Calculations Prerequisites : Documentation for the VizQL Data Service
Troubleshooting : Documentation for the VizQL Data Service
Using VizQL Data Service with Postman : Documentation for the VizQL Data Service
What's New : Documentation for the VizQL Data Service
VizQL Data Service Introduction : Documentation for the VizQL Data Service
VizQL Data Service
About Tableau Help : Documentation for the Tableau Web Data Connector
Create a Basic Authentication Connector : Documentation for the Tableau Web Data Connector
Create a Cloud File Connector : Documentation for the Tableau Web Data Connector
Create a Custom Parse Connector : Documentation for the Tableau Web Data Connector
Create an Earthquake Data Connector : Documentation for the Tableau Web Data Connector
Create an Earthquake Data JavaScript Connector : Documentation for the Tableau Web Data Connector
Create an OAuth Connector : Documentation for the Tableau Web Data Connector
Customize Your Connector : Documentation for the Tableau Web Data Connector
Considerations for Building Your Connector : Documentation for the Tableau Web Data Connector
Development Overview : Documentation for the Tableau Web Data Connector
Get Data - Best Practices : Documentation for the Tableau Web Data Connector
WDC Incremental Refresh : Documentation for the Tableau Web Data Connector
Join Filtering : Documentation for the Tableau Web Data Connector
WDC Versions : Documentation for the Tableau Web Data Connector
Web Data Connector SDK License Agreement : Documentation for the Tableau Web Data Connector
WDC Node.js Proxy with OAuth Tutorial : Documentation for the Tableau Web Data Connector
Web Data Connector Overview : Documentation for the Tableau Web Data Connector
Package and Sign Your Connector for Distribution : Documentation for the Tableau Web Data Connector
WDC Lifecycle and Phases : Documentation for the Tableau Web Data Connector
Supported Date Formats : Documentation for the Tableau Web Data Connector
TACO Toolkit Reference : Documentation for the Tableau Web Data Connector
Connector Boilerplates : Documentation for the Tableau Web Data Connector
Customize Your First WDC Connector : Documentation for the Tableau Web Data Connector
Use a WDC in Tableau Server : Documentation for the Tableau Web Data Connector
Framework and Toolkit Versioning : Documentation for the Tableau Web Data Connector
What's New : Documentation for the Tableau Web Data Connector
Get Started : Documentation for the Tableau Web Data Connector
Connector | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
Logger | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
OAuthCredentials | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
AsyncParser | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
Auth | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
CsvUtils | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
DataContainerBuilder | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
DataTableBuilder | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
ExcelUtils | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
FetchUtils | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
Fetcher | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
ParquetUtils | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
Parser | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
AggType | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
ColumnRole | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
ColumnType | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
DataType | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
GeographicRole | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
NumberFormat | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
UnitsFormat | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
getAuthHeader | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
getBasicAuthHeader | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
getOAuthHeader | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
log | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
@tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
AjaxResponse | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
ConnectorRequestOptions | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
AuthenticateOptions | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
BasicHandlerInput | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
DataContainer | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
DataTable | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
FetchOptions | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
FetchRequestOptions | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
FileBasedHandlerInput | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
LoadCsvDataOptions | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
LoadDataOptions | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
ParseOptions | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
app | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
handlers | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
AuthHeader | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
AuthTokens | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
HandlerInput | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
SecretsType | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
ColumnHeader | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
DataRow | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
FetchArrayBufferOptions | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
FetchJsonOptions | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
Metadata | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit
TacoFileParserName | @tableau/taco-toolkit - v2.1.0 : Documentation for @tableau/taco-toolkit