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

[@salesforce/b2c-tooling-sdk](../../modules.md) / [clients](../index.md) / MetricsClient

# Type Alias: MetricsClient

> **MetricsClient** = `Client`\<`paths`\>

Defined in: [packages/b2c-tooling-sdk/src/clients/metrics.ts:57](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/metrics.ts#L57)

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

```typescript
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](../functions/createMetricsClient.md) for instantiation