Skip to content
View as Markdown
View as Markdown

@salesforce/b2c-tooling-sdk / operations/metrics / getOverallMetrics

Function: getOverallMetrics()

getOverallMetrics(client, tenantId, options?): Promise<{ }>

Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:464

Retrieves overall application metrics for an organization.

Parameters

client

MetricsClient

Metrics API client from createMetricsClient

tenantId

string

Tenant ID (with or without the f_ecom_ prefix)

options?

MetricsTimeWindow

Optional time window (epoch milliseconds)

Returns

Promise<{ }>

The metrics data response

Throws

Error if the request fails

Released under the Apache-2.0 License.