CRM Analytics REST API Overview

You can access CRM Analytics features such as datasets, dashboards, and lenses programmatically using the CRM Analytics REST API.

Using the CRM Analytics REST API, you can:

Send queries directly to the CRM Analytics Platform.
Access datasets that have been imported into the CRM Analytics Platform.
Create and retrieve CRM Analytics lenses.
Create, validate, and update templates for CRM Analytics apps.
Back up and restore previous versions of CRM Analytics dashboards, lenses, and dataflows. See Backup and Restore Previous Versions of CRM Analytics Assets with History API.
Run, schedule, and sync CRM Analytics dataflows, recipes, and connections. See Run, Schedule, and Sync CRM Analytics Data with REST APIs
Retrieve a list of dataflow job nodes and details for each individual node.
Access XMD information.
Create and retrieve standard datasets.
Retrieve a list of dataset versions.
Convert Data Cloud data model objects to datasets.
Create and retrieve CRM Analytics apps.
Create, update, and retrieve CRM Analytics dashboards.
Retrieve a list of dependencies for an application.
Determine what features are available to the user.
Work with and schedule Trend in CRM Analytics report snapshots.
Manipulate synced datasets, also known as connected objects.
Get, add, update, and delete ‘eclair’ geo map charts.
Work with data connectors.
Retrieve or update recipe metadata. See Build, Manage, Schedule, and Run Recipes with REST APIs
Discover whether objects and particular dataset versions have support for sharing inheritance.
Create, update, and retrieve auto-install requests for embedded CRM Analytics applications.
Create and retrieve collections of CRM Analytics resources.
Create, update, and retrieve email subscriptions for updates on important analytics.
Create and retrieve watchlists to track important metrics.
Test JSON template transformation rules.
Download a CRM Analytics dashboard or lens or a Lightning Experience dashboard or report as an image or PDF. For more information see, the Analytics Download resource in the Salesforce Reports and Dashboards REST API Developer Guide.
Get Einstein Discovery predictions on Salesforce objects and more via the smartdatadiscovery API. For more information, see the Einstein Discovery REST API Developer Guide.
Access Search Insights features via the autonomous-analtyics API. For more information, see the Search Insights REST API Developer Guide.

The CRM Analytics REST API is based on the Connect REST API and follows its conventions. For more information about the Connect REST API, see the Connect REST API Developer Guide.

CRM Analytics REST API Developer Guide

CRM Analytics REST API Overview