Tableau CRM REST API Developer Guide

Working with the Tableau CRM REST API
Tableau CRM REST API Overview
Tableau CRM REST API Authentication
Tableau CRM Lightning Web Components
Tableau CRM REST API Reference
Additional Tableau CRM REST API Resources
PDF

Newer Version Available

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

Tableau CRM Lightning Web Components

Use Tableau CRM Lightning Web Components to retrieve data and metadata for Tableau CRM assets, execute queries, and schedule data syncs for recipes and dataflows.

The lightning/analyticsWaveApi module provides wire adapters and JavaScript functions built on top of the Tableau CRM REST API. Use these wire adapters and functions to work with Tableau CRM data and metadata.

Wire Adapters

executeQuery

Executes a Tableau CRM query written in Salesforce Analytics Query Language (SAQL) or standard SQL. For more information on syntax and usage, see the executeQuery reference in the Lightning Web Components Developer Guide.

getAnalyticsLimits

Retrieves the Analytics limits for Tableau CRM. For more information on syntax and usage, see the getAnalyticsLimits reference in the Lightning Web Components Developer Guide.

getDataflowJob

Retrieves a specific Tableau CRM dataflow job. For more information on syntax and usage, see the getDataflowJob reference in the Lightning Web Components Developer Guide.

getDataflowJobs

Retrieves a collection of Tableau CRM dataflow jobs. For more information on syntax and usage, see the getDataflowJobs reference in the Lightning Web Components Developer Guide.

getDataflowJobNode

Retrieves a specific Tableau CRM dataflow job node for a recipe or dataflow. For more information on syntax and usage, see the getDataflowJobNode reference in the Lightning Web Components Developer Guide.

getDataflowJobNodes

Retrieves a collection of Tableau CRM dataflow job nodes for a recipe or dataflow. For more information on syntax and usage, see the getDataflowJobNodes reference in the Lightning Web Components Developer Guide.

getDataset

Retrieves a specific Tableau CRM dataset by ID or developer name. For more information on syntax and usage, see the getDataset reference in the Lightning Web Components Developer Guide.

getDatasets

Retrieves a collection of Tableau CRM datasets. For more information on syntax and usage, see the getDatasets reference in the Lightning Web Components Developer Guide.

getRecipe

Retrieves a specific Tableau CRM recipe by ID. For more information on syntax and usage, see the getRecipe reference in the Lightning Web Components Developer Guide.

getRecipes

Retrieves a collection of Tableau CRM recipes. For more information on syntax and usage, see the getRecipes reference in the Lightning Web Components Developer Guide.

getReplicatedDatasets

Retrieves a collection of Tableau CRM replicated datasets, also known as connected objects. For more information on syntax and usage, see the getReplicatedDatasets reference in the Lightning Web Components Developer Guide.

getSchedule

Retrieves a schedule for a Tableau CRM recipe, dataflow, or data sync. For more information on syntax and usage, see the getSchedule reference in the Lightning Web Components Developer Guide.

getWaveFolders

Retrieves a collection of Tableau CRM apps or folders. For more information on syntax and usage, see the getWaveFolders reference in the Lightning Web Components Developer Guide.

getXmd

Retrieves a specific Tableau CRM extended metadata type (Xmd) for a version of a dataset. For more information on syntax and usage, see the getXmd reference in the Lightning Web Components Developer Guide.

Functions

createDataflowJob

Creates a Tableau CRM dataflow job, which is the equivalent of clicking Run Now for a data prep recipe, a data sync, or a dataflow in the Tableau CRM Data Manager UI. For more information on syntax and usage, see the createDataflowJob reference in the Lightning Web Components Developer Guide.

deleteDataset

Deletes a specific Tableau CRM by ID or developer name. For more information on syntax and usage, see the deleteDataset reference in the Lightning Web Components Developer Guide.

deleteRecipe

Deletes a specific Tableau CRM by ID. For more information on syntax and usage, see the deleteRecipe reference in the Lightning Web Components Developer Guide.

updateDataflowJob

Updates a Tableau CRM dataflow job, which is the equivalent of clicking Stop for a data prep recipe, a data sync, or a dataflow in the Tableau CRM Data Manager UI. For more information on syntax and usage, see the updateDataflowJob reference in the Lightning Web Components Developer Guide.

updateSchedule

Updates the schedule for a Tableau CRM data prep recipe, data sync, or dataflow. For more information on syntax and usage, see the updateSchedule reference in the Lightning Web Components Developer Guide.