b2c-metrics

B2C Metrics Skill

::: danger CLOSED BETA The Metrics API is a closed beta feature. It must be enabled for your organization, and its behavior, output, and OAuth scopes may change without notice. :::

Use the b2c metrics commands to query observability metrics from the SCAPI Metrics API (observability/metrics/v1). This provides time-series metrics data for monitoring and analyzing Commerce Cloud technical performance.

Tip: If b2c is not installed globally, use npx @salesforce/b2c-cli.

Command Structure

metrics
├── list                          - list available metric categories
├── overall                       - system-wide aggregate metrics
├── sales                         - sales transaction metrics
├── ecdn                          - edge CDN performance
├── third-party                   - third-party service integrations
│   └── Flags:
│       └── --third-party-service-id  - filter by service ID
├── scapi                         - SCAPI request volume/latency/errors/cache
│   └── Flags:
│       ├── --api-family          - filter by API family
│       └── --api-name            - filter by API name
├── scapi-hooks                   - SCAPI hook execution metrics
├── mrt                           - Managed Runtime (PWA Kit) metrics
├── controller                    - SFRA controller performance
└── ocapi                         - OCAPI request metrics
    └── Flags:
        ├── --ocapi-category      - filter by OCAPI category
        └── --ocapi-api           - filter by OCAPI API

Common Flags (all category commands):
├── --from / --to / --window      - time window (relative "1h"/"7d" or ISO 8601)
└── --tags / --no-tags            - enrich series with structured tags (default: true)

Configuration

Values like tenantId, shortCode, clientId, and clientSecret resolve from dw.json / SFCC_* env vars / the active instance / configuration plugins. Examples below show minimal usage; add flags only to override configured values — passing --client-id/--client-secret/--tenant-id/--short-code is usually unnecessary. If a required value is missing, the CLI emits an actionable error pointing at the flag, env var, and config key.