CRM Analytics REST API Developer Guide

CRM Analytics REST API Overview
Quick Start
Examples
Resources
CRM Analytics REST API Resources Overview
Wave Resource
Actions Resource
Analytics Assets Resources
Annotation Resources
Asset Files Resources
Auto-Install Request Resources
Collection Resources
Dashboard Resources
Data Connector Resources
Dataflow Job Resources
Dataflow Resources
Dataset Resources
Dependencies Resource
Eclair Chart Resources
Features Configuration Resource
Folder Resources
JsonXform Transformation Resource
Limits Resource
Lens Resources
Query Resource
Recipe Resources
Replicated Dataset Resources
Schedule Resource
Subscription Resources
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Template Resources
Trended Report Resources
Watchlist Resources
Xmd Resources
Requests
Responses
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

CRM Analytics REST API Resources Overview

The CRM Analytics REST API provides resources so you can access your CRM Analytics data.

All CRM Analytics REST API resources are accessed using:

  • A base URL for your company (for example, https://yourInstance.salesforce.com)
  • Version information (for example, /services/data/v53.0)
  • A named resource (for example, /wave)
Put together, an example of the full URL to the resource is:
1https://yourInstance.salesforce.com/services/data/v53.0/wave

Org and Object Identifiers

Id fields in Salesforce, and in the CRM Analytics UI, are typically 15-character, base-62, case-sensitive strings. This is true of JSON XMD too. However, many Salesforce APIs, including the CRM Analytics REST API, use 18-character, case-insensitive strings—for example, the Id property of the Dataset resource/wave/datasets/<dataset ID>. The last 3 digits are a checksum of the preceding 15 characters. The use of case-insensitive Id’s eases interaction with external applications and development environments that use case-insensitive references. To convert an 18-character Id back to a 15-character ID, simply remove the last 3 characters.

General Resources

General resources for CRM Analytics are covered here, while specific features like dashboards and recipes have their own sections.

Resource Description Supported HTTP Method Resource URL
Actions Resource Returns the Salesforce actions available for the user in Analytics. GET /wave
Dependencies Resource Returns the dependencies for an asset. GET /wave/dependencies/<folderId>
Feature Configuration Resource Returns the CRM Analytics features that are available to a user. GET /wave/config/features
JsonXform Transformation Resource Performs a JSON transformation. POST /jsonxform/transformation
Limits Resource Get the Analytics limits for the Salesforce org. GET /wave/limits
Query Resource Executes a query written in Salesforce Analytics Query Language (SAQL). POST /wave/query
Security Resources Discover whether objects and particular dataset versions have support for sharing inheritance. GET
  • /wave/security/coverage/​datasets/<datasetIdOrApiName>/​versions/<versionId>
  • /wave/security/coverage/objects/​<objectApiName>
Wave Resource Lists the top-level resources available for CRM Analytics. GET /wave

Filtering REST Responses

Returns the representation for a CRM Analytics application or folder (GET), replaces an application or folder (PUT), updates it (PATCH), or deletes it (DELETE).

In addition to CRM Analytics REST API input parameters, you can use the following Connect REST API input parameters to filter the results returned from a request: filterGroup, external, and internal. For more information, see Specifying Response Sizes in the Connect REST API Developer Guide.