Skip to main content
GET
Obter uma métrica operacional

Autorizações

Authorization
string
header
obrigatório

Chave de API opaca mvy_test_ enviada como token Bearer. O servidor deriva dela exatamente uma clínica odontológica; o caminho nunca leva um seletor de clínica odontológica.

Parâmetros de caminho

metric
enum<string>
obrigatório

A chave da métrica, da lista permitida.

Opções disponíveis:
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

Restringe as métricas de estoque (LOW_STOCK, EXPIRING_STOCK) a um insumo do catálogo.

from
string<date-time>

Início inclusivo da janela, em ISO-8601, para APPROVAL_DECISION_MEDIAN_HOURS (por envio) e DISTINCT_CUSTODY_ACTORS (por recebimento).

to
string<date-time>

Fim exclusivo dessa janela, em ISO-8601.

Resposta

A métrica solicitada.

metric
enum<string>
obrigatório
Opções disponíveis:
LOW_STOCK,
EXPIRING_STOCK,
DELIVERY_EXCEPTIONS,
RECEIPT_DISCREPANCIES,
PENDING_ORDERS,
BOX_TRACEABILITY,
APPROVAL_DECISION_MEDIAN_HOURS,
DISTINCT_CUSTODY_ACTORS
value
number | null
obrigatório

O número; null quando uma porcentagem ou mediana não tem amostra, nunca zero.

unit
string
obrigatório

A unidade do valor: count, percent ou hours.

timezone
string
obrigatório
asOf
string<date-time>
obrigatório

Quando a métrica foi calculada.

freshness
enum<string>
obrigatório
Opções disponíveis:
live
evidenceId
string
obrigatório

Um descritor estável da métrica e de seus filtros, para drill-down e citação.

truncated
boolean
obrigatório

true quando uma leitura limitada atingiu o teto: o valor é um limite inferior.

filters
object
obrigatório
definition
string

O que o número mede, em palavras.

numerator
integer

O que uma porcentagem conta.

denominator
integer

Pelo que uma porcentagem é dividida.

sampleCount
integer

Quantas observações sustentam o número.

caveats
string[]

Limitações do número, legíveis por máquina, por exemplo wall_clock_hours_no_business_calendar.

currency
string
period
object