> ## Documentation Index
> Fetch the complete documentation index at: https://muveya.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi.pt.json get /v1/analytics/exports/{exportId}
openapi: 3.1.0
info:
  description: >-
    A API pública para desenvolvedores da Muveya: recursos /v1 somente leitura,
    limitados a um tenant e autenticados com uma chave de API opaca. Um
    orçamento de solicitações por chave.
  title: API para desenvolvedores da Muveya
  version: 0.1.0
servers:
  - description: Produção
    url: https://api.muveya.com
security: []
tags:
  - name: Chave de API
  - name: Clínicas
  - name: Depósitos
  - name: Catálogo
  - name: Inventário
  - name: Pedidos
  - name: Entregas
  - name: Análises
paths:
  /v1/analytics/exports/{exportId}:
    get:
      tags:
        - Análises
      summary: Consultar uma exportação do resumo gerencial
      description: >-
        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.
      operationId: getAnalyticsExport
      parameters:
        - name: exportId
          in: path
          required: true
          description: >-
            O id opaco da tarefa de exportação retornado por POST
            /v1/analytics/exports.
          schema:
            type: string
      responses:
        '200':
          description: A tarefa de exportação.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsExport'
          headers:
            X-RateLimit-Limit:
              description: O orçamento de solicitações por chave na janela atual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitações restantes na janela atual (0 quando esgotadas).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos até a janela atual ser reiniciada.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado do orçamento de solicitações segundo o rascunho da IETF,
                por exemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política segundo o rascunho da IETF, por exemplo "120;w=60"
                (limite;segundos da janela).
              schema:
                type: string
        '401':
          description: >-
            A chave de API está ausente, é inválida, foi revogada, expirou ou
            está vinculada a uma clínica odontológica suspensa.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: A chave de API não tem o escopo que esta rota exige.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Não existe uma exportação com esse id nesta clínica odontológica.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: A chave de API excedeu seu limite de solicitações na janela atual.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            Retry-After:
              description: >-
                Segundos (valor positivo) até que outra solicitação seja
                permitida.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: O orçamento de solicitações por chave na janela atual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitações restantes na janela atual (0 quando esgotadas).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos até a janela atual ser reiniciada.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado do orçamento de solicitações segundo o rascunho da IETF,
                por exemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política segundo o rascunho da IETF, por exemplo "120;w=60"
                (limite;segundos da janela).
              schema:
                type: string
      security:
        - apiKeyBearer: []
components:
  schemas:
    AnalyticsExport:
      type: object
      additionalProperties: false
      required:
        - exportId
        - status
        - reportType
        - period
      properties:
        exportId:
          type: string
          description: O identificador opaco para consultar a tarefa de exportação.
        status:
          type: string
          enum:
            - pending
            - building
            - ready
            - failed
        reportType:
          type: string
          enum:
            - briefing
        period:
          type: string
          enum:
            - daily
            - weekly
        byteSize:
          type: integer
          description: Tamanho do arquivo gerado em bytes; presente quando estiver pronto.
        checksum:
          type: string
          description: >-
            SHA-256 em hexadecimal do arquivo sem dados sensíveis, o checksum de
            FR-AUD-02; presente quando estiver pronto.
        error:
          type: string
          description: >-
            Um código de motivo legível por máquina e não sensível; presente
            apenas quando a tarefa falhou.
        downloadUrl:
          type: string
          description: >-
            Uma URL de download assinada de curta duração; presente apenas
            quando está pronta e gerada novamente a cada consulta.
        downloadExpiresAt:
          type: string
          format: date-time
          description: Quando a URL de download atual deixa de funcionar.
    ProblemDetails:
      type: object
      additionalProperties: false
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
        - requestId
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          minimum: 400
          maximum: 599
        detail:
          type: string
        instance:
          type: string
        code:
          type: string
        requestId:
          type: string
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.