Tableau CRM REST API Developer Guide
Winter '27 preview (API version 68.0)
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Action Input
Advanced Property Value Input
Annotation Input
Asset Reference Input
Asset Revert History Input
Auto-Install App Configuration Input
Auto-Install Configuration
Auto-Install Request Insert Input
Auto-Install Request Update Input
Base Asset Input
Base Asset Reference Input
Base Auto-Install Request Input
Base Wave Folder Input
Constant Input
Data Connector Input
Data Connector Property
Dataflow Input
Dataflow Job Input
Dataset Input
Dataset Version Input
Event Based Schedule Input
Featured Assets Input
Geo Data Input
Hourly Schedule Input
Json Transformation Input
License Attributes Input
Live Connection Input
Macro Input
Map Bounding Box Input
Map Input
Monthly Relative Schedule Input
Monthly Specific Schedule Input
Recipe Configuration Collection Input
Recipe Configuration Fiscal Input
Recipe Configuration Fiscal Offset Input
Recipe Configuration
Recipe Conversion Detail Input
Recipe Definition Input
Recipe Input
Recipe Notification Input
Replicated Dataset Input
Replicated Field Collection Input
Replicated Field Input
Restore Dataset Version Input
Rule Definition Input
Rule Input
SAQL Query Input
Schedule Input (Asset)
Source Object Data Input
Template Input
Template Options Input
Time Input
Typed Asset Reference Input
Wave Collection Input
Wave Collection Item Input
Wave Collection Item List Input
Wave Collection Pin Input
Wave Folder Input
Wave Folder Share Input
Wave Folder Template Input
Weekly Schedule Input (Asset)
Xmd Dataset Input
Xmd Date Field Input
Xmd Date Input
Xmd Derived Dimension Input
Xmd Derived Dimension Member Input
Xmd Derived Dimension Salesforce Action Input
Xmd Derived Measure Format Input
Xmd Derived Measure Input
Xmd Dimension Input
Xmd Dimension Member Input
Xmd Dimension Salesforce Action Input
Xmd Input
Xmd Measure Format Input
Xmd Measure Input
Xmd Organization Input
Newer Version Available
Tableau CRM REST API Request Bodies
To perform a POST, PATCH, or PUT request, pass query parameters
or create a request body formatted in either XML or JSON. This chapter
lists the request bodies. The query parameters are listed with each
resource.
To create a JSON request body, specify the properties of the request body in JSON format.
This is an example of a Comment request
body.
If a request body is top-level, it has a root XML tag listed. To create an XML request body, nest the properties as XML tags inside the root XML tag.
This is the same Tableau CRM request body in XML
format:
-
Action Input
The action for a rule or macro to perform during a JSON transformation. -
Advanced Property Value Input
An advanced property name and value pair. -
Annotation Input
A Tableau CRM annotation. -
Asset Reference Input
A Tableau CRM asset reference. This wraps the BaseAssetReferenceInput -
Asset Revert History Input
The Tableau CRM asset history to use for a revert request. -
Auto-Install App Configuration Input
The configuration for a auto-install app. -
Auto-Install Configuration
The configuration for a auto-install app. -
Auto-Install Request Insert Input
The insert for an auto-install request. -
Auto-Install Request Update Input
The update for an auto-install request. -
Base Asset Input
The base Tableau CRM asset input, inherited by BaseDashboardInput, BaseLensInput, DataConnectorInput, DataflowInput, DatasetInput, TemplateInput. -
Base Asset Reference Input
The base Tableau CRM asset, inherited by AssetInputReference, SlackInputReference, TypedAssetInputReference. -
Base Auto-Install Request Input
The base auto-install request input, inherited by Auto-Install Request Insert Input and Auto-Install Request Update Input. -
Base Wave Folder Input
The base Tableau CRM folder asset. -
Constant Input
The definition of a constant for JSON transformation rules. -
Data Connector Input
A Tableau CRM data connector. -
Data Connector Property
A property for a Tableau CRM data connector. -
Dataflow Input
A Tableau CRM dataflow. -
Dataflow Job Input
A Tableau CRM dataflow job. -
Dataset Input
A Tableau CRM dataset. -
Dataset Version Input
A specific version of a Tableau CRM dataset. -
Event Based Schedule Input
Specify an event-driven schedule for a Tableau CRM recipe or dataflow. -
Featured Assets Input
A feaatured assets for a Tableau CRM app. -
Geo Data Input
The geo data used by a map. -
Hourly Schedule Input
Specify a sub-daily schedule for a Tableau CRM asset. -
Json Transformation Input
The JSON request to perform transformation rules on. -
License Attributes Input
The Analytics license attributes. -
Live Connection Input
The connection details of a Tableau CRM live dataset. -
Macro Input
A macro to use for a JSON transformation rule. -
Map Bounding Box Input
A bounding box of a map.. -
Map Input
A map for an Eclair chart. -
Monthly Relative Schedule Input
Specify a monthly schedule for a Tableau CRM asset where the day are relative to their location in the week. -
Monthly Specific Schedule Input
Specify a monthly schedule for a Tableau CRM asset where the days are fixed by numerical date. -
Recipe Configuration Collection Input
A collection of Tableau CRM data prep recipe configurations. -
Recipe Configuration Fiscal Input
The Tableau CRM data prep recipe fiscal configuration data. -
Recipe Configuration Fiscal Offset Input
The Tableau CRM data prep recipe fiscal offset configuration data. -
Recipe Configuration
A Tableau CRM Data Prep recipe configuration. -
Recipe Conversion Detail Input
The details for the upconversion of a Tableau CRM data prep recipe. -
Recipe Definition Input
The definition for a Tableau CRM data prep recipe. Available on for R3 recipes. -
Recipe Input
A Tableau CRM data prep recipe. -
Recipe Notification Input
A notification for a Tableau CRM data prep recipe. -
Replicated Dataset Input
A Tableau CRM replicated dataset, also know as a connected object. -
Replicated Field Collection Input
A collection of fields for a Tableau CRM replicated dataset, also known as a connected object. -
Replicated Field Input
A field for a Tableau CRM replicated dataset, also known as a connected object. -
Restore Dataset Version Input
A specific version to restore a Tableau CRM dataset to. -
Rule Definition Input
A rule definition to use for a JSON transformation. -
Rule Input
A rule for a JSON Transformation rule definition. -
SAQL Query Input
A Tableau CRM query written in SAQL. -
Schedule Input (Asset)
A daily schedule on which to execute some type of Tableau CRM job. -
Source Object Data Input
The request to retrieve data from a source object given a list of fields and advanced properties. -
Template Input
A Tableau CRM template. -
Template Options Input
The template options used to upgrade a templated Tableau CRM app. -
Time Input
The time at which something should happen, usually in relation to a Tableau CRM schedule. -
Typed Asset Reference Input
A typed Tableau CRM asset reference. -
Wave Collection Input
A collection of Tableau CRM resources. -
Wave Collection Item Input
An item in a collection of Tableau CRM resources. -
Wave Collection Item List Input
A list of items in a collection of Tableau CRM resources. -
Wave Collection Pin Input
The pinning rules for a Tableau CRM collection. -
Wave Folder Input
A Tableau CRM folder. This implements BaseWaveFolderInput. -
Wave Folder Share Input
A Tableau CRM folder sharing rule. -
Wave Folder Template Input
A templated Tableau CRM folder. This implements BaseWaveFolderInput. -
Weekly Schedule Input (Asset)
Specify a weekly schedule for a Tableau CRM asset. -
Xmd Dataset Input
The extended metadata (Xmd) for a Tableau CRM dataset. -
Xmd Date Field Input
The extended metadata (Xmd) for the formatting of a date field. -
Xmd Date Input
The extended metadata (Xmd) for a date. -
Xmd Derived Dimension Input
The extended metadata (Xmd) for a derived dimension in a Tableau CRM dataset. -
Xmd Derived Dimension Member Input
The extended metadata (Xmd) for a member of a derived dimension in a Tableau CRM dataset. -
Xmd Derived Dimension Salesforce Action Input
The extended metadata (Xmd) for a Saleforce Action for a derived dimension in a Tableau CRM dataset. -
Xmd Derived Measure Format Input
The extended metadata (Xmd) for the format of a derived measure in a Tableau CRM dataset. -
Xmd Derived Measure Input
The extended metadata (Xmd) for a derived measure in a Tableau CRM dataset. -
Xmd Dimension Input
The extended metadata (Xmd) for a dimension in a Tableau CRM dataset. -
Xmd Dimension Member Input
The extended metadata (Xmd) for a member linked to a dimension in Tableau CRM dataset. -
Xmd Dimension Salesforce Action Input
The extended metadata (Xmd) for a Saleforce Action for a dimension in a Tableau CRM dataset. -
Xmd Input
The extended metadata (Xmd) for a Tableau CRM dataset version. -
Xmd Measure Format Input
The extended metadata (Xmd) for the format of a measure in a Tableau CRM dataset. -
Xmd Measure Input
The extended metadata (Xmd) for a measure in a Tableau CRM dataset. -
Xmd Organization Input
The extended metadata (Xmd) for an organization in a Tableau CRM dataset.