@salesforce/b2c-tooling-sdk / operations/metrics / ScapiMetricsOptions

Interface: ScapiMetricsOptions

Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:121

Options for getScapiMetrics: time window plus optional SCAPI filters.

Extends

• MetricsTimeWindow

Properties

apiFamily?

optional apiFamily: string

Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:123

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

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

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

Inherited from

MetricsTimeWindow.from

---

to?

optional to: number | Date

Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:106

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

Inherited from

MetricsTimeWindow.to