@salesforce/b2c-tooling-sdk / clients / MetricsClient

Type Alias: MetricsClient

MetricsClient = Client<paths>

Defined in: packages/b2c-tooling-sdk/src/clients/metrics.ts:57

The typed Metrics API client for retrieving observability metrics.

Common Endpoints

Method	Path	Description
GET	/organizations/{organizationId}/metrics/overall	Overall application metrics
GET	/organizations/{organizationId}/metrics/sales	Sales metrics
GET	/organizations/{organizationId}/metrics/scapi	SCAPI request metrics

Example

import { createMetricsClient, toOrganizationId } from '@salesforce/b2c-tooling-sdk/clients';
import { OAuthStrategy } from '@salesforce/b2c-tooling-sdk/auth';

const auth = new OAuthStrategy({ clientId: '...', clientSecret: '...' });
const client = createMetricsClient({ shortCode: 'kv7kzm78', tenantId: 'zzxy_prd' }, auth);

const { data, error } = await client.GET('/organizations/{organizationId}/metrics/overall', {
  params: { path: { organizationId: toOrganizationId('zzxy_prd') } },
});

See

createMetricsClient for instantiation