Wave REST API Developer Guide
jNewer Version Available
Wave REST API Resources Overview
The Wave REST API provides
resources so you can access your Wave Analytics
data.
All Wave REST API resources are accessed using:
- A base URI for your company (for example, https://yourInstance.salesforce.com)
- Version information (for example, /services/data/v39.0)
- A named resource (for example, /wave)
1hhttps://yourInstance.salesforce.com/services/data/v39.0/waveOrg and Object Identifiers
Id fields in Salesforce, and in the Wave UI, are typically 15-character, base-62, case-sensitive strings. This is true of JSON XMD too. However, many Salesforce APIs, including the Wave REST API, use 18-character, case-insensitive strings—for example, the Id property of the Dataset resource/wave/datasets/<dataset ID>. The last three digits are a checksum of the preceding 15 characters. The use of case-insensitive Id’s eases interaction with external applications and development environments that use case-insensitive references. To convert an 18-character Id back to a 15-character ID, simply remove the last three characters.
| 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, DELETE, PATCH | /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, POST | /wave/lenses/<lens ID> |
| Lens File Resource | Returns a file that is part of a Wave Analytics lens. | GET, PUT | /wave/lenses/<lenses ID>/files/<files ID> |
| Dashboards List Resource | Returns a list of Wave Analytics dashboards, or creates a dashboard. | GET, POST | /wave/dashboards |
| Dashboard Resource | Returns or updates the dashboard with the specified ID or API name. | GET, DELETE, PATCH | /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). | 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> |
| Replicated Datasets Resource | Replicates data from an external Source Object into a Wave as a dataset. Replicated Datasets are not intended to be visualized directly, but are used like a cache to speed up other workflows which refer to the same source object. | GET, PATCH, DELETE | /wave/replicatedDatasets/<ID> |
| Replicated Datasets List Resource | Returns a list of replicated datasets. | GET, POST | wave/replicatedDatasets |
| Replicated Dataset Fields Resource | A list of Replicated Fields for a particular Replicated Dataset. | GET, PATCH | /wave/replicatedDatasets/<ID>/fields |
| Templates List Resource | Returns a list of Wave Analytics templates, or adds a template. | GET | /wave/templates |
| Templates Resource | Returns a list of Wave Analytics templates, or adds a template. | GET | /wave/templates/<templateIdOrApiName> |
| Templates Configuration Resource | Returns the configuration of a Wave Analytics template. | GET | /wave/templates/<templateIdOrApiName>/configuration |
| Trended Reports List Resource | Returns or adds to a collection of Trending Reports. | GET, POST | /wave/trendedreports |
| Trended Reports Resource | Returns, deletes, or updates a Trending Report. | DELETE, GET, PATCH | /wave/trendedreports/<Id> |
| Lens File Metadata Resource | Resource for management of Wave lens file metadata. | GET, POST | /wave/lenses/<lensId>/files |
| Features Configuration Resource | The Wave features that are available to a user. | GET | /wave/config/features |
| Annotations List Resource | A collection of annotations. | GET, POST | /wave/annotations |
| Annotations Resource | An asset's annotations. | GET, PATCH | /wave/annotations/<Annotation ID> |
| Template Release Notes Resource | Resource for retrieving the release notes for a single Wave Analytics Template. | GET | /wave/templates/<templateIdOrApiName>/releasenotes |
| Charts Maps List Resource | Get the collection of maps, or post a new map. | GET POST | /eclair/maps |
| Charts Maps Resource | Get, update, or delete a specific map. | DELETE GET PATCH | /eclair/maps/<id> |
| Charts Geodata Resource | Get, update, or delete a specific geodata definition. | DELETE GET PATCH | /eclair/geodata/<id> |
| Charts Geodata List Resource | Get the collection of geodata definitions, or post a new one. | GET POST | /eclair/geodata |
| Charts Geodata File List Resource | Get the binary file associated with a geodata definition. | GET | /eclair/geodata/<id>/file |
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 Guide.