---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / operations/metrics

# operations/metrics

Metrics operations for B2C Commerce (Observability).

This module provides typed, high-level functions for retrieving operational
time-series metrics from the SCAPI Observability Metrics API
(`observability/metrics/v1`). Each metric *category* has its own function; all
return the same [MetricsDataResponse](../../clients/type-aliases/MetricsDataResponse.md) envelope.

## Categories

- [getOverallMetrics](functions/getOverallMetrics.md) — overall application metrics
- [getSalesMetrics](functions/getSalesMetrics.md) — sales metrics
- [getEcdnMetrics](functions/getEcdnMetrics.md) — embedded CDN metrics
- [getThirdPartyMetrics](functions/getThirdPartyMetrics.md) — third-party service call metrics (filterable by service)
- [getScapiMetrics](functions/getScapiMetrics.md) — SCAPI request metrics (filterable by API family/name)
- [getScapiHooksMetrics](functions/getScapiHooksMetrics.md) — SCAPI hook execution metrics
- [getMrtMetrics](functions/getMrtMetrics.md) — Managed Runtime metrics
- [getControllerMetrics](functions/getControllerMetrics.md) — controller/pipeline metrics
- [getOcapiMetrics](functions/getOcapiMetrics.md) — OCAPI request metrics (filterable by category/api)

[getMetricsByCategory](functions/getMetricsByCategory.md) dispatches to the correct function by category
name — convenient for CLIs and tools that take a category as input.

## Usage

```typescript
import {createMetricsClient} from '@salesforce/b2c-tooling-sdk/clients';
import {getOverallMetrics} from '@salesforce/b2c-tooling-sdk/operations/metrics';

const client = createMetricsClient({shortCode, tenantId}, auth);
const result = await getOverallMetrics(client, tenantId, {from, to});
for (const metric of result.data) {
  console.log(metric.title, metric.dataSeries.length);
}
```

## Authentication

Requires OAuth client-credentials with the `sfcc.metrics` admin scope. The
createMetricsClient factory attaches this scope plus the tenant scope
automatically.

## Interfaces

- [MetricsTagContext](interfaces/MetricsTagContext.md)
- [MetricsTaggedResponse](interfaces/MetricsTaggedResponse.md)
- [MetricsTimeWindow](interfaces/MetricsTimeWindow.md)
- [MetricsWindowInput](interfaces/MetricsWindowInput.md)
- [OcapiMetricsOptions](interfaces/OcapiMetricsOptions.md)
- [ResolvedMetricsWindow](interfaces/ResolvedMetricsWindow.md)
- [ScapiMetricsOptions](interfaces/ScapiMetricsOptions.md)
- [ThirdPartyMetricsOptions](interfaces/ThirdPartyMetricsOptions.md)

## Type Aliases

- [MetricCategory](type-aliases/MetricCategory.md)
- [MetricsBoundInput](type-aliases/MetricsBoundInput.md)
- [MetricSeriesTags](type-aliases/MetricSeriesTags.md)
- [MetricsQueryOptions](type-aliases/MetricsQueryOptions.md)

## Variables

- [METRIC\_CATEGORIES](variables/METRIC_CATEGORIES.md)
- [METRICS\_DEFAULT\_WINDOW\_MS](variables/METRICS_DEFAULT_WINDOW_MS.md)
- [METRICS\_RETENTION\_MS](variables/METRICS_RETENTION_MS.md)
- [METRICS\_RETENTION\_SAFETY\_MARGIN\_MS](variables/METRICS_RETENTION_SAFETY_MARGIN_MS.md)

## Functions

- [enrichMetricsTags](functions/enrichMetricsTags.md)
- [getControllerMetrics](functions/getControllerMetrics.md)
- [getEcdnMetrics](functions/getEcdnMetrics.md)
- [getMetricsByCategory](functions/getMetricsByCategory.md)
- [getMrtMetrics](functions/getMrtMetrics.md)
- [getOcapiMetrics](functions/getOcapiMetrics.md)
- [getOverallMetrics](functions/getOverallMetrics.md)
- [getSalesMetrics](functions/getSalesMetrics.md)
- [getScapiHooksMetrics](functions/getScapiHooksMetrics.md)
- [getScapiMetrics](functions/getScapiMetrics.md)
- [getThirdPartyMetrics](functions/getThirdPartyMetrics.md)
- [parseMetricsBound](functions/parseMetricsBound.md)
- [parseSeriesTags](functions/parseSeriesTags.md)
- [resolveMetricsWindow](functions/resolveMetricsWindow.md)

## References

### Metric

Re-exports [Metric](../../clients/type-aliases/Metric.md)

***

### MetricDataPoint

Re-exports [MetricDataPoint](../../clients/type-aliases/MetricDataPoint.md)

***

### MetricDataSeries

Re-exports [MetricDataSeries](../../clients/type-aliases/MetricDataSeries.md)

***

### MetricsClient

Re-exports [MetricsClient](../../clients/type-aliases/MetricsClient.md)

***

### MetricsClientConfig

Re-exports [MetricsClientConfig](../../clients/interfaces/MetricsClientConfig.md)

***

### MetricsDataResponse

Re-exports [MetricsDataResponse](../../clients/type-aliases/MetricsDataResponse.md)

***

### MetricsError

Re-exports [MetricsError](../../clients/type-aliases/MetricsError.md)