@salesforce/b2c-tooling-sdk / operations/metrics / ResolvedMetricsWindow
Interface: ResolvedMetricsWindow
Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:238
A resolved metrics window. Both from and to are always present: the resolver derives whichever bound the caller left open using the 24-hour default window (see METRICS_DEFAULT_WINDOW_MS) and always sends an explicit range, so the request never depends on the server's implicit to. Epoch-second echoes are included for reporting.
Properties
clampedFrom
clampedFrom:
boolean
Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:256
True when from was clamped forward to stay inside the retention window (see METRICS_RETENTION_SAFETY_MARGIN_MS). Surfaced so callers can report that the effective start differs slightly from what was requested.
defaultedWindow
defaultedWindow:
boolean
Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:262
True when a bound was derived from the 24-hour default window rather than supplied by the caller (e.g. from alone, to alone, or nothing at all). Surfaced so callers can note that the effective range was defaulted.
from
from:
Date
Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:240
Resolved start bound.
fromEpochSeconds
fromEpochSeconds:
number
Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:248
Epoch seconds form of from (the API wire unit).
fromIso
fromIso:
string
Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:244
ISO 8601 form of from.
to
to:
Date
Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:242
Resolved end bound.
toEpochSeconds
toEpochSeconds:
number
Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:250
Epoch seconds form of to (the API wire unit).
toIso
toIso:
string
Defined in: packages/b2c-tooling-sdk/src/operations/metrics/index.ts:246
ISO 8601 form of to.