Analytics REST API Developer Guide
jNewer Version Available
Analytics REST API Resources Overview
The Analytics REST API provides resources so you can access your Analytics
data.
All Analytics REST API resources are accessed using:
- A base URL for your company (for example, https://yourInstance.salesforce.com)
- Version information (for example, /services/data/v42.0)
- A named resource (for example, /wave)
1https://yourInstance.salesforce.com/services/data/v42.0/waveOrg and Object Identifiers
Id fields in Salesforce, and in the Analytics UI, are typically 15-character, base-62, case-sensitive strings. This is true of JSON XMD too. However, many Salesforce APIs, including the Analytics REST API, use 18-character, case-insensitive strings—for example, the Id property of the Dataset resource/wave/datasets/<dataset ID>. The last 3 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 3 characters.
| Resource | Description | Supported HTTP Method | Resource URL |
|---|---|---|---|
| Wave Resource | Lists the top-level resources available for Analytics. | GET | /wave |
| Query Resource | Executes a query written in Salesforce Analytics Query Language (SAQL). | POST | /wave/query |
| Datasets List Resource | Returns a collection of Analytics datasets and creates a dataset. | GET POST | /wave/datasets |
| Dataset Resource | Returns the Analytics dataset with the specified ID, deletes a dataset (DELETE), or updates a dataset (PATCH). | GET, DELETE, PATCH | /wave/datasets/<datasetIdOrApiName> |
| Dataset Versions List Resource | Returns a collection of dataset versions for a particular dataset. | GET | /wave/datasets/<datasetIdOrApiName>/versions |
| Dataset Version Resource | Returns an Analytics dataset version (GET), or updates the predicate (PATCH). | GET, PATCH | /wave/datasets/<datasetIdOrApiName>/versions/<versionId> |
| File Resource | Provides access to the binary content of the dataset file. | GET | /wave/datasets/<datasetIdOrApiName>/versions/<versionId>/files/<fileId> |
| XMD List Resource | Returns a collection of XMD resources for a version of a dataset. This collection is for main, system, and user XMD types. To view asset type XMDs, refer to the Asset XMD API resource. | GET | /wave/datasets/<dataset ID>/versions/<versionId>/xmds |
| XMD Resource | Returns the extended metadata (XMD) for a version of a dataset and updates the user XMD file. | GET, PUT | /wave/datasets/<dataset ID>/versions/<versionId>/xmds/<xmdType> |
| Lenses List Resource | Returns a collection of Analytics lenses, or creates a lens. | GET, POST | /wave/lenses |
| Lens Resource | Returns a JSON file that describes the structure of an Analytics lens with the specified ID, deletes a lens, or updates a lens. | GET, DELETE, PATCH | /wave/lenses/<lensIdOrApiName> |
| Lens Bundle Resource | Returns a JSON file that describes the structure of an Analytics lens bundle with the specified ID or updates a lens bundle. | GET, PUT | /wave/lenses/<lensIdOrApiName>/bundle |
| Lens File Resource | Returns a file that is part of an Analytics lens. | GET, PUT | /wave/lenses/<lensIdOrApiName>/files/<files ID> |
| Dashboards List Resource | Returns a collection of 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/<dashboardIdOrApiName> |
| Dashboard Bundle Resource | Returns or updates the dashboard bundle with the specified ID or API name. | GET, PUT | /wave/dashboards/<dashboardIdOrApiName>/bundle |
| Dashboard Histories Resource | Returns the dashboard histories with the specified ID or API name. | GET | /wave/dashboards/<dashboardIdOrApiName>/histories |
| Dashboard Publishers Resources | Work with dashboard version publishers. | GET DELETE POST |
|
| Dashboard Saved Views Resources | Work with saved views. | GET DELETE PATCH POST |
|
| Dependencies Resource | Returns the dependencies for an asset. | GET | /wave/dependencies/<folderId> |
| Folder Resource | Returns a collection of folders, creates a folder, updates a folder, or deletes a folder. | GET, POST, PATCH, DELETE |
|
| Replicated Datasets Resource | Returns, updates, and deletes replicated datasets, also know as connected objects. A data sync loads source object data as a connected object in Analytics. Connected objects can’t be visualized directly, but are used like a cache to speed up other jobs that pull from the source object and load it into a dataset. | GET, PATCH, DELETE | /wave/replicatedDatasets/<replicatedDatasetId> |
| Replicated Datasets List Resource | Returns a collection of replicated datasets, also know as connected objects. | GET, POST | wave/replicatedDatasets |
| Replicated Dataset Fields Resource | Returns a collection of fields for the specified connected object. | GET, PATCH | /wave/replicatedDatasets/<replicatedDatasetId>/fields |
| Templates List Resource | Returns a collection of Analytics templates, or creates a template. | GET POST | /wave/templates |
| Template Resource | Returns a collection of Analytics templates, or creates a template. | GET POST | /wave/templates/<templateIdOrApiName> |
| Template Configuration Resource | Returns the configuration of an Analytics template. | GET | /wave/templates/<templateIdOrApiName>/configuration |
| Auto-Install Request Resource | Returns a collection of auto-install requests, creates, updates, or deletes an auto-install request. | GET PATCH POST DELETE | /wave/auto-install-requests /wave/auto-install-requests/<autoInstallRequestId> |
| 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 Analytics lens file metadata. | GET POST | /wave/lenses/<lensId>/files |
| Features Configuration Resource | Returns the Analytics features that are available to a user. | GET | /wave/config/features |
| Annotations List Resource | Returns a collection of annotations. | GET POST | /wave/annotations |
| Annotations Resource | Returns or updates an annotation. | GET PATCH | /wave/annotations/<annotationId> |
| Template Release Notes Resource | Resource for retrieving the release notes for a single Analytics Template. | GET | /wave/templates/<templateIdOrApiName>/releasenotes |
| Charts Maps List Resource | Returns a collection of maps, or creates a 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 | Returns a collection of geodata definitions, or creates a geodata definition. | GET POST | /eclair/geodata |
| Charts Geodata File List Resource | Get the binary file associated with a geodata definition. | GET | /eclair/geodata/<id>/file |
| Data Connector Resources | Work with data connectors. | GET DELETE PATCH POST |
|
| Recipe Resources | Retrieve or update recipes. | GET DELETE PATCH |
|
| Dataflows Resources | Work with dataflows. | GET POST PATCH |
|
| Dataflow Jobs Resources | Work with dataflow jobs. | GET POST PATCH |
|
| Dataflow Jobs Nodes Resources | Get dataflow job nodes. | GET |
|
| Security Resources | Discover whether objects and particular dataset versions have support for sharing inheritance. | GET |
|
Filtering REST Responses
Returns the representation for an Analytics
application or folder (GET), replaces an application or folder (PUT), updates it (PATCH), or
deletes it (DELETE).
In addition to Analytics REST API input parameters, you can use the following Connect 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 Connect REST API Developer Guide.