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

Interface: OcapiMetricsOptions

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

Options for getOcapiMetrics: time window plus optional OCAPI filters.

Extends

• MetricsTimeWindow

Properties

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

---

ocapiApi?

optional ocapiApi: string

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

Restrict results to a specific OCAPI API.

---

ocapiCategory?

optional ocapiCategory: string

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

Restrict results to an OCAPI category (e.g. shop, data).

---

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