CRM Analytics REST API Developer Guide
jSummer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
CRM Analytics REST API Resources Overview
Wave Resource
Actions Resource
Dependencies Resource
Features Configuration Resource
JsonXform Transformation Resource
Limits Resource
Query Resource
Recipe Resources
Schedule Resource
Security Coverage Dataset Version Resource
Security Coverage Object Resource
CRM Analytics REST Resources
REST API resources are sometimes called endpoints.
-
Wave Resource
Lists the top-level resources available for Analytics. -
Actions Resource
Returns the Salesforce actions available for the user in Analytics. The entityId is the user id. -
Analytics Assets Resources
Query Analytics assets using parameters for a collections or query a single asset by ID. -
Annotation Resources
Annotate Analytics dashboard widgets with comments posted in the dashboard and in Chatter. -
Asset Files Resources
Analytics assets contain files to define their previews. Get a collection of files available and individual files, and create and update asset files -
Auto-Install Request Resources
Auto-Install requests are used to create, update, and delete Analytics embedded apps. Analytics embedded apps are run-time implementations of Analytics templates and instead of user interaction, they’re managed via auto-install requests. -
Collection Resources
Analytics collections let users manage their own groups of items and personalize their Analytics Studio home page. -
Dashboard Resources
Analytics dashboards allow users to continuously monitor key metrics of their business. These resources allow users to manage collections of dashboards, individual dashboards, dashboard saved views, dashboard histories, and dashboard publishers. -
Data Connector Resources
Data connectors are prebuilt connectors to quickly connect to data in your Salesforce orgs, apps, data warehouses, and database services. These resources allow users to manage data connectors and their source objects, run data syncs, and check statuses. -
Dataflow Job Resources
Dataflow jobs are used to sync data for data prep recipes and standard dataflows. -
Dataflow Resources
Dataflows are used to prepare data for Analytics, creating one or more datasets using transformations to manipulate the data. -
Dataset Resources
Manage Analytics dataset and dataset versions. -
Dependencies Resource
Returns the dependencies for an asset. -
Eclair Chart Resources
Eclair charts render maps and geodata in Analytics dashboards. -
Features Configuration Resource
The Analytics features that are available to a user. -
Folder Resources
Analytics folders represent apps, a collection of assets. Folders can be created by users or by Analytics templates. -
JsonXform Transformation Resource
Performs a JSON transformation by invoking a set of rules and expressions on a JSON document. The transformed JSON is returned in the REST response and isn't saved on the server. This service is provided to test rules used in Analytics templates. -
Limits Resource
The Analytics limits for the Salesforce org. -
Lens Resources
Analytics lenses are how users view data in a dataset and are the basis for building any dashboard. These resources allow users to manage collections of lenses, individual lenses, and lens files. -
Query Resource
Executes a query written in Salesforce Analytics Query Language (SAQL) or SQL for CRM Analytics. -
Recipe Resources
Recipes are used to prepare data, creating a dataset using transformations to manipulate the data. -
Replicated Dataset Resources
Manage Analytics replicated datasets, also know as connected objects. A data sync loads source object data as a connected object in Analytics. Connected objects can’t be visualized directly, but are used like a cache to speed up other jobs that pull from the source object and load it into a dataset. -
Schedule Resource
Retrieve, create or delete a schedule for a dataflow, recipe, or connection sync. -
Subscription Resources
Manages subscriptions for Analytics dashboards. -
Security Coverage Dataset Version Resource
Returns the security coverage (sharing inheritance) for a particular dataset version. The source objects listed are local to the org (there are no objects from other orgs or other external sources). -
Security Coverage Object Resource
Returns the security coverage for a particular object. Use this API to discover whether Analytics can inherit sharing settings from an object. -
Template Resources
Manage Analytics templates, template configuration, and template release notes. -
Trended Report Resources
Manage Analytics trending reports. -
Watchlist Resources
Manages watchlists for Analytics dashboards. -
Xmd Resources
Manages Xmds for Analytics datasets and assets.