Analytics REST API Developer Guide

Working with the Analytics REST API
Analytics REST API Overview
Backup and Restore Previous Versions of Analytics Assets with History API
Run, Schedule, and Sync Einstein Analytics Data with REST APIs
Analytics REST API Authentication
Analytics REST API Reference
Additional Analytics REST API Resources
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Analytics REST API Overview

You can access Analytics features such as datasets, dashboards, and lenses programmatically using the Analytics REST API.
Using the Analytics REST API, you can:
  • Send queries directly to the Analytics Platform.
  • Access datasets that have been imported into the Analytics Platform.
  • Create and retrieve Analytics lenses.
  • Back up and restore previous versions of Analytics dashboards, lenses, and dataflows. See Backup and Restore Previous Versions of Analytics Assets with History API.
  • Run, schedule, and sync Analytics dataflows, recipes, and connections. See Run, Schedule, and Sync Einstein 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.
  • Create and retrieve Analytics applications.
  • Create, update, and retrieve Analytics dashboards.
  • Retrieve a list of dependencies for an application.
  • Determine what features are available to the user.
  • Work with and schedule Trend in 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.
  • Discover whether objects and particular dataset versions have support for sharing inheritance.
  • Create, update, and retrieve auto-install requests for embedded Analytics applications.
  • Get Einstein Discovery predictions on Salesforce objects via the SmartDataDiscovery API. For more information, see Einstein Prediction Service.

The 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.

The internal API, that was previously used in the Analytics user interface, also labeled as private and for Salesforce only, is not supported. This internal API is deprecated, as first noted in API version 36. Clients using this internal private API can’t access any newly created or updated dashboard assets created using tools in the latest release. We encourage developers of such clients to port them to the Analytics API GA.

Important