Tableau CRM REST API Developer Guide

Tableau CRM REST API Overview
Tableau CRM REST API Authentication
Tableau CRM Lightning Web Components
API End-of-Life
Examples
Resources
Requests
Responses
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Tableau CRM REST API Overview

You can access Tableau CRM features such as datasets, dashboards, and lenses programmatically using the Tableau CRM REST API.
Using the Tableau CRM REST API, you can:
  • Send queries directly to the Tableau CRM Platform.
  • Access datasets that have been imported into the Tableau CRM Platform.
  • Create and retrieve Tableau CRM lenses.
  • Back up and restore previous versions of Tableau CRM dashboards, lenses, and dataflows. See Backup and Restore Previous Versions of Tableau CRM Assets with History API.
  • Run, schedule, and sync Tableau CRM dataflows, recipes, and connections. See Run, Schedule, and Sync Tableau CRM Data with REST APIs
  • Retrieve a list of dataflow job nodes and details for each individual node.
  • Access XMD information.
  • Create and retrieve standard datasets.
  • Retrieve a list of dataset versions.
  • Create and retrieve Tableau CRM apps.
  • Create, update, and retrieve Tableau CRM dashboards.
  • Retrieve a list of dependencies for an application.
  • Determine what features are available to the user.
  • Work with and schedule Trend in Tableau CRM report snapshots.
  • Manipulate synced datasets, also known as connected objects.
  • Get, add, update, and delete ‘eclair’ geo map charts.
  • Work with data connectors.
  • Retrieve or update recipe metadata. See Build, Manage, Schedule, and Run Tableau CRM Recipes with REST APIs
  • Discover whether objects and particular dataset versions have support for sharing inheritance.
  • Create, update, and retrieve auto-install requests for embedded Tableau CRM applications.
  • Create and retrieve collections of Tableau CRM resources.
  • Create, update, and retrieve email subscriptions for updates on important analytics.
  • Create and retrieve watchlists to keep track of important metrics.
  • Test JSON template transformation rules.
  • Get Einstein Discovery predictions on Salesforce objects via the SmartDataDiscovery API. For more information, see Einstein Prediction Service.

The Tableau CRM REST API is based on the Connect REST API and follows its conventions. For more information about the Connect REST API, see the Connect REST API Developer Guide.

The internal API, that was previously used in the Tableau CRM user interface, also labeled as private and for Salesforce only, is not supported. This internal API is deprecated, as first noted in API version 36. Clients using this internal private API can’t access any newly created or updated dashboard assets created using tools in the latest release. We encourage developers of such clients to port them to the Tableau CRM API GA.

Important