Skip to main content
GET
Obtener una métrica operativa

Autorizaciones

Authorization
string
header
requerido

Clave de API opaca mvy_test_ enviada como token Bearer. El servidor deriva de ella exactamente una clínica dental; la ruta nunca lleva un selector de clínica dental.

Parámetros de ruta

metric
enum<string>
requerido

La clave de la métrica, de la lista permitida.

Opciones disponibles:
LOW_STOCK,
EXPIRING_STOCK,
DELIVERY_EXCEPTIONS,
RECEIPT_DISCREPANCIES,
PENDING_ORDERS,
BOX_TRACEABILITY,
APPROVAL_DECISION_MEDIAN_HOURS,
DISTINCT_CUSTODY_ACTORS

Parámetros de consulta

catalogItemId
string

Limita las métricas de existencias (LOW_STOCK, EXPIRING_STOCK) a un insumo del catálogo.

from
string<date-time>

Inicio inclusivo de la ventana, en ISO-8601, para APPROVAL_DECISION_MEDIAN_HOURS (por envío) y DISTINCT_CUSTODY_ACTORS (por recepción).

to
string<date-time>

Fin exclusivo de esa ventana, en ISO-8601.

Respuesta

La métrica solicitada.

metric
enum<string>
requerido
Opciones disponibles:
LOW_STOCK,
EXPIRING_STOCK,
DELIVERY_EXCEPTIONS,
RECEIPT_DISCREPANCIES,
PENDING_ORDERS,
BOX_TRACEABILITY,
APPROVAL_DECISION_MEDIAN_HOURS,
DISTINCT_CUSTODY_ACTORS
value
number | null
requerido

La cifra; null cuando un porcentaje o una mediana no tiene muestra, nunca cero.

unit
string
requerido

La unidad del valor: count, percent o hours.

timezone
string
requerido
asOf
string<date-time>
requerido

Cuándo se calculó la métrica.

freshness
enum<string>
requerido
Opciones disponibles:
live
evidenceId
string
requerido

Un descriptor estable de la métrica y sus filtros, para el drill-down y la cita.

truncated
boolean
requerido

true cuando una lectura acotada alcanzó su tope: el valor es un límite inferior.

filters
object
requerido
definition
string

Lo que mide la cifra, en palabras.

numerator
integer

Lo que cuenta un porcentaje.

denominator
integer

Entre qué se divide un porcentaje.

sampleCount
integer

Cuántas observaciones respaldan la cifra.

caveats
string[]

Límites de la cifra, legibles por máquina, por ejemplo wall_clock_hours_no_business_calendar.

currency
string
period
object