curl --request GET \
--url https://api.muveya.com/v1/analytics/exports/{exportId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.muveya.com/v1/analytics/exports/{exportId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.muveya.com/v1/analytics/exports/{exportId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"exportId": "<string>",
"status": "pending",
"reportType": "briefing",
"period": "daily",
"byteSize": 123,
"checksum": "<string>",
"error": "<string>",
"downloadUrl": "<string>",
"downloadExpiresAt": "2023-11-07T05:31:56Z"
}{
"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>"
}Consultar una exportación del resumen gerencial
Consulta un trabajo de exportación por su id opaco. Requiere analytics:read. Un trabajo ready trae una URL de descarga firmada de corta duración (se genera de nuevo en cada consulta) y el checksum del archivo; un trabajo failed trae un motivo no sensible. Se limita a la clínica dental a la que está vinculada la clave; un id desconocido devuelve 404 sin revelar si existe en otro lugar.
curl --request GET \
--url https://api.muveya.com/v1/analytics/exports/{exportId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.muveya.com/v1/analytics/exports/{exportId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.muveya.com/v1/analytics/exports/{exportId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"exportId": "<string>",
"status": "pending",
"reportType": "briefing",
"period": "daily",
"byteSize": 123,
"checksum": "<string>",
"error": "<string>",
"downloadUrl": "<string>",
"downloadExpiresAt": "2023-11-07T05:31:56Z"
}{
"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
El id opaco del trabajo de exportación que devuelve POST /v1/analytics/exports.
Respuesta
El trabajo de exportación.
El identificador opaco para consultar el trabajo de exportación.
pending, building, ready, failed briefing daily, weekly Tamaño del archivo generado en bytes; aparece cuando está listo.
SHA-256 en hexadecimal del archivo sin datos sensibles, el checksum de FR-AUD-02; aparece cuando está listo.
Un código de motivo legible por máquina y no sensible; solo aparece cuando el trabajo falló.
Una URL de descarga firmada de corta duración; solo aparece cuando está lista y se genera de nuevo en cada consulta.
Cuándo deja de funcionar la URL de descarga actual.