CRM Analytics Assets SDK Aura Component

Discover CRM Analytics dashboards, lenses and datasets, get their details, and dig into dataset fields. Discover dashboard saved views and explore dashboard state. Create and execute queries directly on datasets

Call the SDK

To call the SDK, declare the wave:sdk component in your component or app.

<wave:sdk aura:id="sdk"/>

Use sdk.invokeMethod to specify the method and any parameters.

sdk.invokeMethod(context, methodName, methodParameters, callback)

For example, here’s a call that uses listDashboards as methodName.

var context = {};
   var methodName = 'listDashboards';
   var methodParameters = {
     'pageSize' : 200,
     'sort' : 'Name'
   };

   sdk.invokeMethod(context, methodName, methodParameters,
   $A.getCallback(function (err, data) {
   if (err !== null) {
     //DO THIS IF THE METHOD FAILS
     console.error("SDK error", err);
   } else {
     //DO THIS IF THE METHOD SUCCEEDS
     component.set('v.dashboards', data.dashboards);
   }
}))

See the wave:sdk Component Reference for a full working example.

Each method has its own set of parameters (methodParameters).

Methods and Parameters

listDashboards

Retrieves a list of all dashboards. Can be filtered by specifying parameters

listLenses

Retrieves a list of all lenses. Can be filtered by specifying parameters

listDatasets

Retrieves a list of all datasets. Can be filtered by specifying parameters

describeDashboard

Retrieves the details of a single dashboard.

describeLens

Retrieves the details of a single lens.

describeDataset

Retrieves the details of a single dataset.

getDatasetFields

Retrieves a list of all the fields for a single dataset.

executeQuery

Executes a CRM Analytics SAQL query.

listDashboardSavedViews

Retrieves a list of all saved views for a dashboard.

getDashboardSavedView

Retrieves the detail of one dashboard saved view.

getDashboardInitialSavedView

Retrieves the initial view information for a dashboard saved view.