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

# Listar exceções operacionais

> Lista as exceções operacionais que o painel gerencial mostra (estoque a vencer ou baixo, exceções de entrega, divergências no recebimento, aprovações pendentes) em uma ordem de prioridade estável, cada uma com um id de drill-down e um descritor de evidência. Requer analytics:read. Determinístico; calculado ao vivo sobre os dados da clínica odontológica.



## OpenAPI

````yaml /openapi.pt.json get /v1/analytics/exceptions
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/exceptions:
    get:
      tags:
        - Análises
      summary: Listar exceções operacionais
      description: >-
        Lista as exceções operacionais que o painel gerencial mostra (estoque a
        vencer ou baixo, exceções de entrega, divergências no recebimento,
        aprovações pendentes) em uma ordem de prioridade estável, cada uma com
        um id de drill-down e um descritor de evidência. Requer analytics:read.
        Determinístico; calculado ao vivo sobre os dados da clínica
        odontológica.
      operationId: listAnalyticsExceptions
      parameters:
        - name: catalogItemId
          in: query
          required: false
          description: >-
            Restringe as exceções de estoque (baixo ou a vencer) a um insumo do
            catálogo.
          schema:
            type: string
      responses:
        '200':
          description: As exceções operacionais priorizadas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationalExceptionReport'
          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'
        '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:
    OperationalExceptionReport:
      type: object
      additionalProperties: false
      required:
        - total
        - timezone
        - asOf
        - freshness
        - evidenceId
        - truncated
        - filters
        - exceptions
      properties:
        total:
          type: integer
        timezone:
          type: string
        asOf:
          type: string
          format: date-time
          description: Quando o relatório foi calculado.
        freshness:
          type: string
          enum:
            - live
        evidenceId:
          type: string
        truncated:
          type: boolean
          description: >-
            true quando uma leitura limitada atingiu o teto: a lista contém
            apenas as primeiras linhas.
        filters:
          type: object
          additionalProperties:
            type: string
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/OperationalException'
    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
    OperationalException:
      type: object
      additionalProperties: false
      required:
        - metric
        - priority
        - drillDownType
        - drillDownId
        - reference
        - evidenceId
      properties:
        metric:
          type: string
          enum:
            - LOW_STOCK
            - EXPIRING_STOCK
            - DELIVERY_EXCEPTIONS
            - RECEIPT_DISCREPANCIES
            - PENDING_ORDERS
            - BOX_TRACEABILITY
            - APPROVAL_DECISION_MEDIAN_HOURS
            - DISTINCT_CUSTODY_ACTORS
        priority:
          type: integer
          description: Posição de prioridade estável; 0 é a mais urgente.
        drillDownType:
          type: string
          enum:
            - order
            - movement
            - item
          description: >-
            Para o que o id de drill-down aponta: um pedido de origem, uma
            movimentação de estoque de origem ou o insumo quando um alerta de
            estoque foi detectado sem uma movimentação (um mínimo salvo ou a
            verificação periódica).
        drillDownId:
          type: string
          description: >-
            O id do registro de origem que o drill-down abre (acessível com a
            mesma chave e os mesmos escopos).
        reference:
          type: object
          additionalProperties:
            type: string
        evidenceId:
          type: string
          description: Um descritor estável da exceção, por item, para citação.
        detectedAt:
          type: string
          format: date-time
  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.