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

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

# Interface: ScapiMetricsOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/metrics/index.ts:121](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/metrics/index.ts#L121)

Options for [getScapiMetrics](../functions/getScapiMetrics.md): time window plus optional SCAPI filters.

## Extends

- [`MetricsTimeWindow`](MetricsTimeWindow.md)

## Properties

### apiFamily?

> `optional` **apiFamily**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/metrics/index.ts:123](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/metrics/index.ts#L123)

Restrict results to a SCAPI API family (e.g. `product`, `checkout`).

***

### apiName?

> `optional` **apiName**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/metrics/index.ts:125](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/metrics/index.ts#L125)

Restrict results to a SCAPI API name (e.g. `shopper-products`).

***

### from?

> `optional` **from**: `number` \| `Date`

Defined in: [packages/b2c-tooling-sdk/src/operations/metrics/index.ts:104](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/metrics/index.ts#L104)

Start of the window — a Date or epoch milliseconds (inclusive).

#### Inherited from

[`MetricsTimeWindow`](MetricsTimeWindow.md).[`from`](MetricsTimeWindow.md#from)

***

### to?

> `optional` **to**: `number` \| `Date`

Defined in: [packages/b2c-tooling-sdk/src/operations/metrics/index.ts:106](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/metrics/index.ts#L106)

End of the window — a Date or epoch milliseconds (inclusive).

#### Inherited from

[`MetricsTimeWindow`](MetricsTimeWindow.md).[`to`](MetricsTimeWindow.md#to)