Skip to main content
POST
Solicitar uma exportação do resumo gerencial

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.

Cabeçalhos

Accept-Language
string

O idioma dos rótulos dos números do CSV: en, es ou pt (padrão en), definido quando a exportação é solicitada. As chaves de métrica, dimensões, unidades, valores e ids de evidência nunca mudam com ele.

Corpo

application/json
period
enum<string>

A frequência do resumo gerencial a exportar; o padrão é daily.

Opções disponíveis:
daily,
weekly

Resposta

A tarefa de exportação foi aceita.

exportId
string
obrigatório

O identificador opaco para consultar a tarefa de exportação.

status
enum<string>
obrigatório
Opções disponíveis:
pending,
building,
ready,
failed
reportType
enum<string>
obrigatório
Opções disponíveis:
briefing
period
enum<string>
obrigatório
Opções disponíveis:
daily,
weekly
byteSize
integer

Tamanho do arquivo gerado em bytes; presente quando estiver pronto.

checksum
string

SHA-256 em hexadecimal do arquivo sem dados sensíveis, o checksum de FR-AUD-02; presente quando estiver pronto.

error
string

Um código de motivo legível por máquina e não sensível; presente apenas quando a tarefa falhou.

downloadUrl
string

Uma URL de download assinada de curta duração; presente apenas quando está pronta e gerada novamente a cada consulta.

downloadExpiresAt
string<date-time>

Quando a URL de download atual deixa de funcionar.