The Tableau Next Connect REST API provides resources to access your Tableau Next assets and more.
All Tableau Next Connect REST API resources are accessed using:
- A base URL for your Salesforce org (
https://<your_instance_name>) - The Connect API version information (
/services/data/v67.0) - The Tableau Next resource (
/tableau/visualizations)
Put together, a full URL is:
https://<your_instance_name>/services/data/v67.0/tableau/visualizations</your_instance_name>
Org and Object Identifiers
ID fields in Salesforce, and in Tableau Next, are typically 15-character, base-62, case-sensitive strings. This is also true of JSON XMD. However, many Salesforce APIs, including the Tableau Next Connect REST API, use 18-character, case-insensitive strings. For example, the id property of the asset resource appears in a path like the following:
/tableau/workspaces/{workspaceIdOrApiName}/assets/{assetId}
The last 3 characters are a checksum of the preceding 15 characters. Case-insensitive IDs ease interaction with external applications and development environments that use case-insensitive references. To convert an 18-character ID back to a 15-character ID, remove the last 3 characters.
Tableau Next Resources
| Resource | Description | Supported HTTP Methods | Resource URL |
|---|---|---|---|
| Assets | Clones an asset. | POST | /tableau/assets/clone |
| Compares two or more assets. | POST | /tableau/assets/compare | |
| Returns the assets that depend on a specified asset. | POST | /tableau/assets/dependencies | |
| Returns the references contained within a specified asset. | GET | /tableau/assets/{assetId}/references | |
| Dashboards | Returns a collection of dashboards or creates a new dashboard. | GET, POST | /tableau/dashboards |
| Returns, updates, or deletes a dashboard with the specified ID or API name. | GET, PATCH, DELETE | /tableau/dashboards/{dashboardIdOrApiName} | |
| Returns the bundle for a dashboard with the specified ID or API name. | GET | /tableau/dashboards/{dashboardIdOrApiName}/bundle | |
| Returns a collection of custom views for a dashboard or creates a new custom view. | GET, POST | /tableau/dashboards/{dashboardIdOrApiName}/customviews | |
| Returns the default custom view for a dashboard. | GET | /tableau/dashboards/{dashboardIdOrApiName}/customviews/default | |
| Returns the specified custom view, or deletes a custom view. | GET, POST | /tableau/dashboards/{dashboardIdOrApiName}/customviews/{viewId} | |
| Followers | Returns a unique follower count for a specified asset. | GET | /tableau/follow/assets/{followedAssetId}/follower-count |
| Returns a collection of followers for a specified followed asset. | GET | /tableau/follow/assets/{followedAssetId}/followers | |
| Returns a collection of references to the assets a user follows. | GET | /tableau/follow/followers/{followerId}/followed-asset-refs | |
| Returns a collection of followed assets for a user. | GET | /tableau/follow/followers/{followerId}/followed-assets | |
| Adds a user as a follower of a specified asset or collection of assets, or updates a follow. | POST, PATCH | /tableau/follow/followers/{followerId}/follows | |
| Unfollows a specified asset for a specified user. | DELETE | /tableau/follow/followers/{followerId}/follows/{followedAssetId} | |
| Returns submetric information for a specified asset. | POST | /tableau/follow/submetric-info | |
| Marketplace | Returns a marketplace installation with the specified ID. | GET | /tableau/marketplace/installations/{installationId} |
| Returns a collection of marketplace listings or publishes a new listing to the marketplace. | GET, POST | /tableau/marketplace/listings | |
| Unpublishes a listing from the marketplace. | DELETE | /tableau/marketplace/listings/{listingId} | |
| Installs a specified marketplace listing. | GET | /tableau/marketplace/listings/{listingId}/install | |
| Returns the components of a specified marketplace package version. | GET | /tableau/marketplace/packages/{packageVersionId}/components | |
| Creates a marketplace template. | POST | /tableau/marketplace/templates | |
| Personal Orgs | Syncs personal org information. | POST | /tableau/analytics-personal-org-infos |
| Returns a collection of personal orgs. | GET | /tableau/personal-orgs | |
| Returns, updates, or deletes a personal org with the specified ID. | GET, PATCH, DELETE | /tableau/personal-orgs/{personalOrgInfoId} | |
| Record Access Shares | Returns a collection of shares for a specified record for the requesting grantee user, or shares, updates, or deletes access to a specified record. | GET, POST, PATCH, DELETE | /tableau/records/{recordId}/shares |
| Removes access to a specified record for a specified user or group. | DELETE | /tableau/records/{recordId}/shares/{userOrGroupId} | |
| Subscriptions | Returns or updates a user's subscription digest configuration. | GET, PATCH | /tableau/subscriptions/digest/{digestConfigOwner} |
| Visualizations | Returns a collection of visualizations or creates a new visualization. | GET, POST | /tableau/visualizations |
| Returns, updates, or deletes a visualization with the specified ID or API name. | GET, PATCH, DELETE | /tableau/visualizations/{visualizationIdOrApiName} | |
| Returns the bundle for a visualization with the specified ID or API name. | GET | /tableau/visualizations/{visualizationIdOrApiName}/bundle | |
| Workspaces | Returns a collection of workspaces or creates a new workspace. | GET, POST | /tableau/workspaces |
| Returns, updates, or deletes a workspace with the specified ID or API name. | GET, PATCH, DELETE | /tableau/workspaces/{workspaceIdOrApiName} | |
| Returns a collection of assets in a workspace or adds an asset to a workspace. | GET, POST | /tableau/workspaces/{workspaceIdOrApiName}/assets | |
| Adds a batch of assets to a workspace. | POST | /tableau/workspaces/{workspaceIdOrApiName}/assets/batch | |
| Returns, clones, updates, or deletes a specified asset in a workspace. | GET, POST, PATCH, DELETE | /tableau/workspaces/{workspaceIdOrApiName}/assets/{assetId} |