Salesforce Docs Portal

getWaveTemplates

Retrieves a collection of CRM Analytics templates.

Syntax

import { LightningElement, wire } from "lwc";
import { getWaveTemplates } from "lightning/analyticsWaveApi";

export default class GetWaveTemplates extends LightningElement {
  @wire(getWaveTemplates, {
    type: "App",
  })
  onGetWaveTemplates({ data, error }) {
    if (error) {
      console.log("getWaveTemplates ERROR:", error);
    } else if (data) {
      console.log("getWaveTemplates RESPONSE:", data.templates);
    }
  }
}

CRM Analytics API Resource

GET /wave/templates

getWaveTemplates uses this CRM Analytics API resource.

Parameters

These parameters are optional.

Parameter Name Type Description
options String Template visibility options to apply to the collection results. <ul><li>CreateApp</li><li>ManageableOnly</li><li>ViewOnly</li></ul>
type String Template type to apply to the collection results. <ul><li>App</li><li>Dashboard</li><li>Data</li><li>Embedded</li><li>Lens</li></ul>

Returns