getDataset

Retrieves a specific CRM Analytics dataset by ID or developer name.

Syntax 

1import { LightningElement, api, wire } from "lwc";
2import { getDataset } from "lightning/analyticsWaveApi";
3
4export default class GetDataset extends LightningElement {
5  @api idOrApiName; // or fetch the ID or developer name
6  @wire(getDataset, {
7    datasetIdOrApiName: "$idOrApiName",
8  })
9  onGetDataset({ data, error }) {
10    if (error) {
11      console.log("getDataset(${idOrApiName}) ERROR:", error);
12    } else if (data) {
13      console.log("getDataset(${idOrApiName}) RESPONSE:", data);
14    }
15  }
16}

CRM Analytics API Resource 

1GET /wave/datasets/${datasetIdOrApiName}

getDataset uses this CRM Analytics API resource.

Parameters 

Parameter NameTypeDescriptionRequired?
datasetIdOrApiNameStringThe ID or developer name of the dataset.Yes

Returns 

Release Preview

This release is in preview. Features described here don't become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can't guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.