Wave REST API Developer 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
Lens File Resource
Dashboards List Resource
Dashboard Resource
Dependencies Resource
Folders List Resource
Folder Resource
Templates List Resource
Templates Resource
Templates Configuration 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 Wave Analytics 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 Wave Analytics. GET /wave
Query Resource Executes a query written in Salesforce Analytics Query Language (SAQL). POST /wave/query
Datasets List Resource Returns a list of Wave Analytics datasets. GET /wave/datasets
Dataset Resource Returns the Wave Analytics 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 a Wave Analytics 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), and replaces the user XMD file (PUT). GET, PUT /wave/datasets/<dataset ID>​/versions/<version ID>​/xmds/<XMD type>
Lenses List Resource Returns a list of Wave Analytics lenses (GET), or creates a lens (POST). GET, POST /wave/lenses
Lens Resource Returns a JSON file that describes the structure of a Wave Analytics lens with the specified ID (GET), deletes a lens (DELETE), or updates a lens (PATCH). GET, DELETE /wave/lenses/<lens ID>
Lens File Resource Returns a file that is part of a Wave Analytics lens. GET /wave/lenses/<lenses ID>​/files/<files ID>
Dashboards List Resource Returns a list of Wave Analytics dashboards. GET /wave/dashboards
Dashboard Resource Returns the Wave Analytics dashboard with the specified ID. GET /wave/dashboards/<dashboard ID>
Dependencies Resource Returns the dependencies for an application (folder). GET /wave/dependencies/<folder ID>
Folders List Resource Creates a Wave Analytics application (POST), which is a folder that contains Wave datasets, lenses, and dashboards, or returns a collection of applications or folders (GET). POST /wave/folders
Folder Resource Returns the representation for a Wave Analytics application or folder (GET), replaces an application or folder (PUT), updates it (PATCH), or deletes it (DELETE). GET, PUT, PATCH, DELETE /wave/folders/<folder ID>
Templates List Resource Returns list of Wave Analytics templates. GET /wave/templates
Templates Resource Returns list of Wave Analytics templates. GET /wave/templates/<templateIdOrApiName>
Templates Configuration Resource Returns the configuration of a Wave Analytics template. GET /wave/templates/<templateIdOrApiName>/configuration

Filtering REST Responses

Returns the representation for a Wave Analytics application or folder (GET), replaces an application or folder (PUT), updates it (PATCH), or deletes it (DELETE).

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.