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

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

# Interface: MetricsClientConfig

Defined in: [packages/b2c-tooling-sdk/src/clients/metrics.ts:94](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/metrics.ts#L94)

Configuration for creating a Metrics API client.

## Properties

### middlewareRegistry?

> `optional` **middlewareRegistry**: [`MiddlewareRegistry`](../classes/MiddlewareRegistry.md)

Defined in: [packages/b2c-tooling-sdk/src/clients/metrics.ts:119](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/metrics.ts#L119)

Middleware registry to use for this client.
If not specified, uses the global middleware registry.

***

### scopes?

> `optional` **scopes**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/clients/metrics.ts:113](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/metrics.ts#L113)

Optional scope override. If not provided, defaults to the domain scope
(sfcc.metrics) plus the tenant-specific scope (SALESFORCE_COMMERCE_API:{tenant}).

***

### shortCode

> **shortCode**: `string`

Defined in: [packages/b2c-tooling-sdk/src/clients/metrics.ts:100](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/metrics.ts#L100)

The short code for the SCAPI instance.
This is typically a 4-8 character alphanumeric code.

#### Example

```ts
"kv7kzm78"
```

***

### tenantId

> **tenantId**: `string`

Defined in: [packages/b2c-tooling-sdk/src/clients/metrics.ts:107](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/clients/metrics.ts#L107)

The tenant ID (with or without f_ecom_ prefix).
Used to build the organizationId path parameter and tenant-specific OAuth scope.

#### Example

```ts
"zzxy_prd" or "f_ecom_zzxy_prd"
```