Skip to main content
GET
Get an operational metric

Authorizations

Authorization
string
header
required

Opaque mvy_test_ API key sent as a Bearer token. It derives exactly one workspace server-side; the path never carries a workspace selector.

Path Parameters

metric
enum<string>
required

The allowlisted metric key.

Available options:
LOW_STOCK,
EXPIRING_STOCK,
DELIVERY_EXCEPTIONS,
RECEIPT_DISCREPANCIES,
PENDING_ORDERS,
BOX_TRACEABILITY,
APPROVAL_DECISION_MEDIAN_HOURS,
DISTINCT_CUSTODY_ACTORS

Query Parameters

catalogItemId
string

Narrows the stock metrics (LOW_STOCK, EXPIRING_STOCK) to one catalog item.

from
string<date-time>

Inclusive ISO-8601 start of the window for APPROVAL_DECISION_MEDIAN_HOURS (by submission) and DISTINCT_CUSTODY_ACTORS (by receipt).

to
string<date-time>

Exclusive ISO-8601 end of that window.

Response

The requested metric.

metric
enum<string>
required
Available options:
LOW_STOCK,
EXPIRING_STOCK,
DELIVERY_EXCEPTIONS,
RECEIPT_DISCREPANCIES,
PENDING_ORDERS,
BOX_TRACEABILITY,
APPROVAL_DECISION_MEDIAN_HOURS,
DISTINCT_CUSTODY_ACTORS
value
number | null
required

The figure; null when a percentage or median has no sample, never zero.

unit
string
required

The value's unit: count, percent or hours.

timezone
string
required
asOf
string<date-time>
required

When the metric was computed.

freshness
enum<string>
required
Available options:
live
evidenceId
string
required

A stable descriptor of the metric and its filters, for drill-down/citation.

truncated
boolean
required

True when a bounded scan hit its cap: the value is a lower bound.

filters
object
required
definition
string

What the figure measures, in words.

numerator
integer

What a percentage counts.

denominator
integer

What a percentage divides by.

sampleCount
integer

How many observations the figure stands on.

caveats
string[]

Machine-readable limits of the figure, e.g. wall_clock_hours_no_business_calendar.

currency
string
period
object