Analytics Embedding SDK

Use the Analytics Embedding SDK to embed Tableau Next analytical components in any web page. This SDK supports typescript, javascript and HTML formats.

This version of the SDK is compatible with Salesforce API v65.0 and above.

Note: The orgUrl parameter must be the Lightning URL (e.g., https://yourorg.lightning.force.com), not the my.salesforce.com domain URL.

The SDK supports embedding components from multiple Salesforce orgs in a single application. Use orgConfigs instead of a single orgUrl and authCredential:

The orgUrl is required when creating components in a multi org scenario, to ensure your component connects to the correct org.

You can add new orgs or retry failed orgs after initial SDK initialization using retryOrAddOrgs:

The retryOrAddOrgs function returns the same BootstrapResponse format as initializeAnalyticsSdk.

The initializeAnalyticsSdk function returns a BootstrapResponse object:

Sample response:

Status values:

  • Status.SUCCESS - All orgs initialized successfully
  • Status.PARTIAL_SUCCESS - Some orgs initialized successfully (multi-org only)
  • Status.FAILURE - Initialization failed

The SDK provides a logout function to log out from Salesforce orgs. The function returns a LogoutResponse with the same structure as BootstrapResponse.

Sample response:

The SDK supports all browsers supported in Salesforce Lightning Experience.