CRM Analytics REST API Resources Overview
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)
https://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 Resource | Lists the top-level resources available for CRM Analytics. | GET | /wave |
Filtering REST Responses
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.