curl --request GET \
--url https://api.muveya.com/v1/analytics/metrics/{metric} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.muveya.com/v1/analytics/metrics/{metric}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.muveya.com/v1/analytics/metrics/{metric}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"metric": "LOW_STOCK",
"value": 123,
"unit": "<string>",
"timezone": "<string>",
"asOf": "2023-11-07T05:31:56Z",
"freshness": "live",
"evidenceId": "<string>",
"truncated": true,
"filters": {},
"definition": "<string>",
"numerator": 123,
"denominator": 123,
"sampleCount": 123,
"caveats": [
"<string>"
],
"currency": "<string>",
"period": {
"from": "<string>",
"to": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>"
}Obter uma métrica operacional
Lê uma métrica operacional determinística da lista permitida como contrato de evidência (value, unit, asOf, filters), calculada ao vivo sobre os dados da clínica odontológica. Requer analytics:read. Um nome de métrica desconhecido retorna 400. As métricas de valor são omitidas a menos que a chave tenha o escopo de valor (nenhuma na v1).
curl --request GET \
--url https://api.muveya.com/v1/analytics/metrics/{metric} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.muveya.com/v1/analytics/metrics/{metric}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.muveya.com/v1/analytics/metrics/{metric}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"metric": "LOW_STOCK",
"value": 123,
"unit": "<string>",
"timezone": "<string>",
"asOf": "2023-11-07T05:31:56Z",
"freshness": "live",
"evidenceId": "<string>",
"truncated": true,
"filters": {},
"definition": "<string>",
"numerator": 123,
"denominator": 123,
"sampleCount": 123,
"caveats": [
"<string>"
],
"currency": "<string>",
"period": {
"from": "<string>",
"to": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>"
}Autorizações
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
A chave da métrica, da lista permitida.
LOW_STOCK, EXPIRING_STOCK, DELIVERY_EXCEPTIONS, RECEIPT_DISCREPANCIES, PENDING_ORDERS, BOX_TRACEABILITY, APPROVAL_DECISION_MEDIAN_HOURS, DISTINCT_CUSTODY_ACTORS Parâmetros de consulta
Restringe as métricas de estoque (LOW_STOCK, EXPIRING_STOCK) a um insumo do catálogo.
Início inclusivo da janela, em ISO-8601, para APPROVAL_DECISION_MEDIAN_HOURS (por envio) e DISTINCT_CUSTODY_ACTORS (por recebimento).
Fim exclusivo dessa janela, em ISO-8601.
Resposta
A métrica solicitada.
LOW_STOCK, EXPIRING_STOCK, DELIVERY_EXCEPTIONS, RECEIPT_DISCREPANCIES, PENDING_ORDERS, BOX_TRACEABILITY, APPROVAL_DECISION_MEDIAN_HOURS, DISTINCT_CUSTODY_ACTORS O número; null quando uma porcentagem ou mediana não tem amostra, nunca zero.
A unidade do valor: count, percent ou hours.
Quando a métrica foi calculada.
live Um descritor estável da métrica e de seus filtros, para drill-down e citação.
true quando uma leitura limitada atingiu o teto: o valor é um limite inferior.
Show child attributes
Show child attributes
O que o número mede, em palavras.
O que uma porcentagem conta.
Pelo que uma porcentagem é dividida.
Quantas observações sustentam o número.
Limitações do número, legíveis por máquina, por exemplo wall_clock_hours_no_business_calendar.
Show child attributes
Show child attributes