> ## 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 o consumo por insumo > Lê o consumo por insumo na sua própria unidade, agrupado por dia ou semana UTC a partir do registro imutável de movimentações de estoque, como contrato de evidência. Requer analytics:read. Quantidades de insumos ou unidades diferentes nunca são somadas; coverage informa as movimentações sem unidade verificada, um alcance de depósitos restrito e a janela coberta quando a leitura é truncada. Uma narração só é incluída quando passa na verificação determinística de fidelidade numérica. Apenas quantidades. Por padrão, a janela são os últimos 30 dias até agora; uma janela malformada, invertida ou ampla demais retorna 400. Determinístico; calculado ao vivo sobre os dados da clínica odontológica. ## OpenAPI ````yaml /openapi.pt.json get /v1/analytics/consumption-trend 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/consumption-trend: get: tags: - Análises summary: Obter o consumo por insumo description: >- Lê o consumo por insumo na sua própria unidade, agrupado por dia ou semana UTC a partir do registro imutável de movimentações de estoque, como contrato de evidência. Requer analytics:read. Quantidades de insumos ou unidades diferentes nunca são somadas; coverage informa as movimentações sem unidade verificada, um alcance de depósitos restrito e a janela coberta quando a leitura é truncada. Uma narração só é incluída quando passa na verificação determinística de fidelidade numérica. Apenas quantidades. Por padrão, a janela são os últimos 30 dias até agora; uma janela malformada, invertida ou ampla demais retorna 400. Determinístico; calculado ao vivo sobre os dados da clínica odontológica. operationId: getAnalyticsConsumptionTrend parameters: - name: from in: query required: false description: >- Início inclusivo da janela, em ISO-8601 (o padrão é 30 dias antes de `to`). schema: type: string format: date-time - name: to in: query required: false description: Fim exclusivo da janela, em ISO-8601 (o padrão é agora). schema: type: string format: date-time - name: granularity in: query required: false description: Tamanho do intervalo; o padrão é `day`. schema: type: string enum: - day - week - name: catalogItemId in: query required: false description: Restringe a tendência a um insumo do catálogo. schema: type: string responses: '200': description: A tendência de consumo. content: application/json: schema: $ref: '#/components/schemas/ConsumptionTrend' 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: A janela está malformada, invertida ou é mais ampla que o máximo. 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: ConsumptionTrend: type: object additionalProperties: false required: - metric - definition - granularity - period - movementCount - timezone - asOf - freshness - evidenceId - truncated - filters - coverage - series - unverifiedItems properties: metric: type: string definition: type: string description: A definição legível da métrica. granularity: type: string enum: - day - week period: type: object additionalProperties: false required: - from - to properties: from: type: string format: date-time to: type: string format: date-time movementCount: type: integer description: Todas as movimentações de consumo lidas, medidas ou não. timezone: type: string asOf: type: string format: date-time freshness: type: string enum: - live evidenceId: type: string truncated: type: boolean description: >- true quando a leitura do registro de movimentações atingiu o teto; a leitura vai da mais recente para a mais antiga, então coverage.coveredFrom indica onde os números começam. filters: type: object additionalProperties: type: string coverage: $ref: '#/components/schemas/ConsumptionCoverage' series: type: array items: $ref: '#/components/schemas/ConsumptionSeries' unverifiedItems: type: array items: $ref: '#/components/schemas/ConsumptionUnverifiedItem' narration: $ref: '#/components/schemas/ConsumptionNarration' 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 ConsumptionCoverage: type: object additionalProperties: false required: - measuredMovementCount - unverifiedMovementCount - warehouseScope properties: measuredMovementCount: type: integer description: Movimentações com unidade verificada, incorporadas às séries. unverifiedMovementCount: type: integer description: >- Movimentações sem unidade verificada, contadas à parte e sem entrar em nenhuma série. warehouseScope: type: string enum: - all - restricted description: >- `restricted` quando o leitor vê apenas alguns depósitos: as séries não são totais da clínica odontológica. coveredFrom: type: string format: date-time description: >- Presente quando a leitura atingiu o limite: os números cobrem apenas [coveredFrom, period.to). ConsumptionSeries: type: object additionalProperties: false description: >- Consumo de um insumo em uma unidade medida. As quantidades são somadas apenas dentro de uma série, nunca entre séries. required: - seriesKey - catalogItemId - unitOfMeasure - totalConsumed - usedQuantity - issuedQuantity - movementCount - buckets properties: seriesKey: type: string description: >- Chave estável da série neste relatório: `:`. catalogItemId: type: string itemName: type: string description: O nome do insumo; omitido quando o catálogo não reconhece mais o id. sku: type: string description: O SKU do insumo; omitido quando o catálogo não reconhece mais o id. unitOfMeasure: type: string description: >- A unidade registrada nas movimentações desta série (identidade de medida imutável). totalConsumed: type: number description: Quantidade consumida, em `unitOfMeasure`. usedQuantity: type: number description: >- O uso observado: estoque registrado onde foi usado, em `unitOfMeasure`. issuedQuantity: type: number description: >- Estoque entregue a salas que não contam seu estoque: um consumo estimado, em `unitOfMeasure`. usedQuantity + issuedQuantity = totalConsumed. movementCount: type: integer buckets: type: array items: $ref: '#/components/schemas/ConsumptionTrendBucket' ConsumptionUnverifiedItem: type: object additionalProperties: false description: >- Um insumo com consumo registrado antes de existir a identidade de unidade: é contado, nunca quantificado. required: - catalogItemId - movementCount properties: catalogItemId: type: string itemName: type: string description: O nome do insumo; omitido quando o catálogo não reconhece mais o id. sku: type: string description: O SKU do insumo; omitido quando o catálogo não reconhece mais o id. movementCount: type: integer ConsumptionNarration: type: object additionalProperties: false description: >- As afirmações que um resumo pode fazer, cada uma igual à evidência na sua própria unidade. Só é incluída quando passa na verificação determinística de fidelidade numérica. required: - evidenceId - period - acknowledgesTruncation - acknowledgesUnverified - acknowledgesRestrictedScope - claims properties: evidenceId: type: string period: type: object additionalProperties: false required: - from - to properties: from: type: string format: date-time to: type: string format: date-time acknowledgesTruncation: type: boolean acknowledgesUnverified: type: boolean acknowledgesRestrictedScope: type: boolean claims: type: array items: oneOf: - type: object additionalProperties: false required: - kind - seriesKey - field - value - unit properties: kind: type: string enum: - series seriesKey: type: string field: type: string enum: - totalConsumed - movementCount value: type: number unit: type: string - type: object additionalProperties: false required: - kind - field - value - unit properties: kind: type: string enum: - coverage field: type: string enum: - movementCount - unverifiedMovementCount value: type: number unit: type: string enum: - movements ConsumptionTrendBucket: type: object additionalProperties: false required: - bucketStart - consumedQuantity - usedQuantity - issuedQuantity - movementCount properties: bucketStart: type: string format: date-time description: Início do intervalo em UTC. consumedQuantity: type: number description: >- Quantidade consumida no intervalo, na unidade da série à qual pertence. usedQuantity: type: number description: 'O uso observado no intervalo: estoque registrado onde foi usado.' issuedQuantity: type: number description: >- Estoque entregue no intervalo a salas que não contam seu estoque: um consumo estimado. usedQuantity + issuedQuantity = consumedQuantity. movementCount: type: integer 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.