`getAnalyticsLimits`

Retrieves the Analytics limits for CRM Analytics.

Syntax

1import { LightningElement, wire } from "lwc";
2import { getAnalyticsLimits } from "lightning/analyticsWaveApi";
3
4export default class GetAnalyticsLimits extends LightningElement {
5  @wire(getAnalyticsLimits, {
6    licenseType: "EinsteinAnalytics",
7    types: ["DatasetQueries"],
8  })
9  onGetAnalyticsLimits({ data, error }) {
10    if (error) {
11      console.log("getAnaltyicsLimits ERROR:", error);
12    } else if (data) {
13      console.log("getAnaltyicsLimits RESPONSE:", data.limits);
14    }
15  }
16}

CRM Analytics API Resource

1GET /wave/limits

getAnalyticsLimits uses thisMeet CRM Analytics API resource.

Parameters

These parameters are optional.

Parameter Name	Type	Description
`licenseType`	String	The response includes CRM Analytics assets with this license type. The default is `EinsteinAnalytics.` `Cdp` (Data Cloud) `DataPipelinesQuery` (Data Pipelines Query) `EinsteinAnalytics` (CRM Analytics) `IntelligentApps` (Intelligent Apps) `MulesoftDataPath` (Mulesoft Data Path) `Sonic` (Salesforce Data Pipelines)
`types`	Array	The types of limits used in CRM Analytics. Valid values are: `BatchTransformationHours`—Maximum dataflow runtime per month. `DatasetQueries`—Maximum queries. `DatasetRowCount`—Maximum rows of all datasets combined. `MaxDailyRowsHighOutputCon`—Maximum rows for all high volume tier output connectors per rolling 24-hour period. `MaxDailySizeHighOutputCon`—Maximum data size for all high volume tier output connectors per rolling 24-hour period. `MaxDailyRowsMedOutputCon`—Maximum rows for all medium volume tier output connectors per rolling 24-hour period. `MaxDailySizeMedOutputCon`—Maximum data size for all medium volume tier output connectors per rolling 24-hour period. `MaxDailyRowsLowOutputCon`—Maximum rows for all low volume tier output connectors per rolling 24-hour period. `MaxDailySizeLowOutputCon`—Maximum data size for all low volume tier output connectors per rolling 24-hour period. `OutputLocalConnectorVolume`—Maximum cumulative bytes of data files written to Salesforce in a rolling 24-hour period.

Returns

data—Wave Analytics Limit Collection
error—FetchResponse

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.