Wave REST API Developer's Guide (Pilot)

Working with the Wave REST API
Wave REST API Reference
Wave REST API Resources Overview (Pilot)
Wave Resource
Query Resource
Datasets List Resource
Dataset Resource
Versions List Resource
Version Resource
File Resource
XMD List Resource
XMD Resource
Lenses List Resource
Lens Resource
Dependencies Resource
Folders List Resource
Folder Resource
PDF

Newer Version Available

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

Wave REST API Resources Overview (Pilot)

The Wave REST API provides resources so you can access your Analytics Cloud data.

We provide this feature to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Because pilot programs are subject to change, we can’t guarantee acceptance. This pilot feature isn’t generally available, as referenced in this document or in press releases or public statements. We can’t guarantee that it will become generally available within any particular time frame or at all. Make your purchase decisions only on the basis of generally available features. Services provided by the Wave REST API are subject to change. Support is not provided.

Note

All Wave REST API resources are accessed using:
  • A base URI for your company (for example, https://na1.salesforce.com)
  • Version information (for example, /services/data/v34.0)
  • A named resource (for example, /wave)
Put together, an example of the full URL to the resource is:
1https://na1.salesforce.com/services/data/v34.0/wave
Resource Description Supported HTTP Method Resource URL
Wave Resource Lists the top-level resources available for Analytics Cloud. GET /wave
Query Resource Executes a query written in Salesforce Analytics Query Language (SAQL). POST /wave/query
Datasets List Resource Returns a list of Analytics Cloud datasets. GET /wave/datasets
Dataset Resource Returns the Analytics Cloud dataset with the specified ID, deletes a dataset (DELETE), or updates a dataset (PATCH). GET /wave/datasets/<dataset ID>
Versions List Resource Returns a collection of dataset versions for a particular dataset. GET /wave/datasets/<dataset ID>​/versions
Version Resource Returns an Analytics Cloud dataset version (GET), or updates the predicate (PATCH). GET, PATCH /wave/datasets/<dataset ID>​/versions/<version ID>
File Resource Provides access to the binary content of the dataset file. GET /wave/datasets/<dataset ID>​/versions/<version ID>​ /files/<file ID>
XMD List Resource Returns a list of XMD resources for a version of a dataset. GET /wave/datasets/<dataset ID>​/versions/<version ID>/xmds
XMD Resource Returns the extended metadata (XMD) for a version of a dataset. GET /wave/datasets/<dataset ID>​/versions/<version ID>​/xmds/<XMD type>
Lenses List Resource Returns a list of Analytics Cloud lenses (GET), or creates a lens (POST). GET, POST /wave/lenses
Lens Resource Returns the Analytics Cloud lens with the specified ID (GET), deletes a lens (DELETE), or updates a lens (PATCH). GET, DELETE /wave/lenses/<lens ID>
Dependencies Resource Returns the dependencies for an application (folder). GET /wave/dependencies/<folder ID>
Folders List Resource Creates an Analytics Cloud application (POST), which is a folder that contains Wave datasets, lenses, and dashboards. POST /wave/folders
Folder Resource Returns the representation for an Analytics Cloud application. GET /wave/folders/<folder ID>

Filtering REST Responses

In addition to Wave REST API input parameters, you can use the following Chatter REST API input parameters to filter the results returned from a request: filterGroup, external, and internal. For more information, see Specifying Response Sizes in the Chatter REST API Developer’s Guide.