Wave REST API Developer Guide

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

Newer Version Available

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

Wave REST API Overview

You can access Wave Analytics datasets and lenses programmatically using the Wave REST API.
Using the Wave REST API, you can:
  • Send queries directly to the Wave Platform.
  • Access datasets that have been imported into the Wave Platform.
  • Create and retrieve Wave Analytics lenses.
  • Access XMD information.
  • Retrieve a list of dataset versions.
  • Create and retrieve Wave Analytics applications.
  • Create, update, and retrieve Wave Analytics dashboards.
  • Retrieve a list of dependencies for an application.
  • Determine what features are available to the user.

The Wave 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 Wave UI, also labeled as private and for Salesforce only, is not supported. This internal API will remain operational for the next 12 months. However, clients using this internal private API will not have access to any newly created or updated dashboard assets created using tools in the Spring '16 release — for example, the Dashboard Designer, or the new Flex Dashboard Designer (Beta). We encourage developers of such clients to port them to the Wave API GA.

Important