> ## 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. # Obter uma métrica operacional > Lê uma métrica operacional determinística da lista permitida como contrato de evidência (value, unit, asOf, filters), calculada ao vivo sobre os dados da clínica odontológica. Requer analytics:read. Um nome de métrica desconhecido retorna 400. As métricas de valor são omitidas a menos que a chave tenha o escopo de valor (nenhuma na v1). ## OpenAPI ````yaml /openapi.pt.json get /v1/analytics/metrics/{metric} 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/metrics/{metric}: get: tags: - Análises summary: Obter uma métrica operacional description: >- Lê uma métrica operacional determinística da lista permitida como contrato de evidência (value, unit, asOf, filters), calculada ao vivo sobre os dados da clínica odontológica. Requer analytics:read. Um nome de métrica desconhecido retorna 400. As métricas de valor são omitidas a menos que a chave tenha o escopo de valor (nenhuma na v1). operationId: getAnalyticsMetric parameters: - name: metric in: path required: true description: A chave da métrica, da lista permitida. schema: type: string enum: - LOW_STOCK - EXPIRING_STOCK - DELIVERY_EXCEPTIONS - RECEIPT_DISCREPANCIES - PENDING_ORDERS - BOX_TRACEABILITY - APPROVAL_DECISION_MEDIAN_HOURS - DISTINCT_CUSTODY_ACTORS - name: catalogItemId in: query required: false description: >- Restringe as métricas de estoque (LOW_STOCK, EXPIRING_STOCK) a um insumo do catálogo. schema: type: string - name: from in: query required: false description: >- Início inclusivo da janela, em ISO-8601, para APPROVAL_DECISION_MEDIAN_HOURS (por envio) e DISTINCT_CUSTODY_ACTORS (por recebimento). schema: type: string format: date-time - name: to in: query required: false description: Fim exclusivo dessa janela, em ISO-8601. schema: type: string format: date-time responses: '200': description: A métrica solicitada. content: application/json: schema: $ref: '#/components/schemas/SemanticMetric' 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 '400': description: O nome não corresponde a uma métrica conhecida. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' 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: SemanticMetric: type: object additionalProperties: false required: - metric - value - unit - timezone - asOf - freshness - evidenceId - truncated - filters properties: metric: type: string enum: - LOW_STOCK - EXPIRING_STOCK - DELIVERY_EXCEPTIONS - RECEIPT_DISCREPANCIES - PENDING_ORDERS - BOX_TRACEABILITY - APPROVAL_DECISION_MEDIAN_HOURS - DISTINCT_CUSTODY_ACTORS value: type: - number - 'null' description: >- O número; null quando uma porcentagem ou mediana não tem amostra, nunca zero. unit: type: string description: 'A unidade do valor: count, percent ou hours.' definition: type: string description: O que o número mede, em palavras. numerator: type: integer description: O que uma porcentagem conta. denominator: type: integer description: Pelo que uma porcentagem é dividida. sampleCount: type: integer description: Quantas observações sustentam o número. caveats: type: array items: type: string description: >- Limitações do número, legíveis por máquina, por exemplo wall_clock_hours_no_business_calendar. timezone: type: string asOf: type: string format: date-time description: Quando a métrica foi calculada. freshness: type: string enum: - live evidenceId: type: string description: >- Um descritor estável da métrica e de seus filtros, para drill-down e citação. truncated: type: boolean description: >- true quando uma leitura limitada atingiu o teto: o valor é um limite inferior. filters: type: object additionalProperties: type: string currency: type: string period: type: object additionalProperties: false required: - from - to properties: from: type: string to: type: string 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.