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 uma exportação do resumo gerencial
Consulta uma tarefa de exportação pelo seu id opaco. Requer analytics:read. Uma tarefa ready traz uma URL de download assinada de curta duração (gerada novamente a cada consulta) e o checksum do arquivo; uma tarefa failed traz um motivo não sensível. Limitada à clínica odontológica à qual a chave está vinculada; um id desconhecido retorna 404 sem revelar se existe em outro 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>"
}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
O id opaco da tarefa de exportação retornado por POST /v1/analytics/exports.
Resposta
A tarefa de exportação.
O identificador opaco para consultar a tarefa de exportação.
pending, building, ready, failed briefing daily, weekly Tamanho do arquivo gerado em bytes; presente quando estiver pronto.
SHA-256 em hexadecimal do arquivo sem dados sensíveis, o checksum de FR-AUD-02; presente quando estiver pronto.
Um código de motivo legível por máquina e não sensível; presente apenas quando a tarefa falhou.
Uma URL de download assinada de curta duração; presente apenas quando está pronta e gerada novamente a cada consulta.
Quando a URL de download atual deixa de funcionar.