Analytics REST API Developer Guide

Working with the Analytics REST API
Analytics REST API Overview
Analytics REST API Authentication
Analytics REST API Reference
PDF

Newer Version Available

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

Analytics REST API Overview

You can access Analytics datasets 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.
  • Access XMD information.
  • 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 replicated datasets.
  • Get, add, update, and delete ‘eclair’ geo map charts.
  • Work with data connectors.
  • Retrieve or update recipes.

The Analytics REST API is based on the Chatter REST API and follows its conventions. For more information about the Chatter REST API, see the Chatter 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 will be depricated, as first noted in API version 36. Clients using this internal private API will not have access to 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