getDataConnectorStatus

Retrieves the status for a specific CRM Analytics data connector by ID or developer name.

Syntax 

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

CRM Analytics API Resource 

1GET /wave/dataConnectors/${connectorIdOrApiName}/status

getDataConnectorStatus uses this CRM Analytics API resource.

Parameters 

Parameter NameTypeDescriptionRequired?
connectorIdOrApiNameStringThe ID or developer name of the data connector.Yes

Returns