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>"
}Obtener una métrica operativa
Lee una métrica operativa determinística de la lista permitida como contrato de evidencia (value, unit, asOf, filters), calculada en vivo sobre los datos de la clínica dental. Requiere analytics:read. Un nombre de métrica desconocido devuelve 400. Las métricas de valor se omiten salvo que la clave tenga el scope de valor (ninguna en 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>"
}Autorizaciones
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
La clave de la métrica, de la 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
Limita las métricas de existencias (LOW_STOCK, EXPIRING_STOCK) a un insumo del catálogo.
Inicio inclusivo de la ventana, en ISO-8601, para APPROVAL_DECISION_MEDIAN_HOURS (por envío) y DISTINCT_CUSTODY_ACTORS (por recepción).
Fin exclusivo de esa ventana, en ISO-8601.
Respuesta
La métrica solicitada.
LOW_STOCK, EXPIRING_STOCK, DELIVERY_EXCEPTIONS, RECEIPT_DISCREPANCIES, PENDING_ORDERS, BOX_TRACEABILITY, APPROVAL_DECISION_MEDIAN_HOURS, DISTINCT_CUSTODY_ACTORS La cifra; null cuando un porcentaje o una mediana no tiene muestra, nunca cero.
La unidad del valor: count, percent o hours.
Cuándo se calculó la métrica.
live Un descriptor estable de la métrica y sus filtros, para el drill-down y la cita.
true cuando una lectura acotada alcanzó su tope: el valor es un límite inferior.
Show child attributes
Show child attributes
Lo que mide la cifra, en palabras.
Lo que cuenta un porcentaje.
Entre qué se divide un porcentaje.
Cuántas observaciones respaldan la cifra.
Límites de la cifra, legibles por máquina, por ejemplo wall_clock_hours_no_business_calendar.
Show child attributes
Show child attributes