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

# Consultar uso

> Retorna o uso medido do projeto no período, com uma linha por combinação de métrica, tipo de canal e provedor. O dia corrente ainda aberto é lido ao vivo. O intervalo tem no máximo 92 dias.



## OpenAPI

````yaml openapi.json GET /v1/usage
openapi: 3.0.3
info:
  title: API da Routa
  description: >-
    API REST para enviar e receber mensagens de WhatsApp, acompanhar a entrega e
    receber eventos normalizados por webhook.
  version: '1'
servers:
  - url: https://api.routa.chat
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Mensagens
    description: Envie, consulte e liste mensagens.
  - name: Eventos
    description: Consulte o log de eventos normalizados.
  - name: Webhooks
    description: Gerencie endpoints de webhook, segredos e entregas.
  - name: Templates
    description: Submeta e consulte templates de WhatsApp.
  - name: Mídia
    description: Envie e obtenha arquivos de mídia.
  - name: Uso
    description: Consulte o uso medido do projeto.
  - name: Identidade
    description: Identifique a chave de API em uso.
paths:
  /v1/usage:
    get:
      tags:
        - Uso
      summary: Consultar uso
      description: >-
        Retorna o uso medido do projeto no período, com uma linha por combinação
        de métrica, tipo de canal e provedor. O dia corrente ainda aberto é lido
        ao vivo. O intervalo tem no máximo 92 dias.
      operationId: retrieveUsage
      parameters:
        - description: Data UTC inicial, no formato `YYYY-MM-DD`, inclusiva.
          schema:
            type: string
          in: query
          name: from
          required: true
        - description: >-
            Data UTC final, no formato `YYYY-MM-DD`, exclusiva. O intervalo tem
            no máximo 92 dias.
          schema:
            type: string
          in: query
          name: to
          required: true
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
        '401':
          description: >-
            Chave de API ausente, inválida, revogada ou expirada
            (`api_key_invalid`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: A chave não tem o escopo necessário (`insufficient_scope`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Requisição inválida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Limite de taxa excedido. Veja o header `Retry-After`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - usage:read
components:
  schemas:
    Usage:
      type: object
      properties:
        from_date:
          description: Início do período (inclusivo).
          type: string
          example: '2026-09-01'
        to_date:
          description: Fim do período (exclusivo).
          type: string
          example: '2026-10-01'
        data:
          type: array
          items:
            type: object
            required:
              - metric
              - channel_type
              - provider
              - quantity
              - unit
            properties:
              metric:
                type: string
                description: Métrica medida.
                example: message.sent
              channel_type:
                type: string
                nullable: true
                description: Tipo do canal, ou `null`.
                example: whatsapp
              provider:
                type: string
                nullable: true
                description: Provedor, ou `null`.
                example: whatsapp_cloud
              quantity:
                type: number
                description: Quantidade no período.
                example: 1840
              unit:
                type: string
                description: Unidade da métrica.
                example: message
          description: Uma linha por combinação de métrica, tipo de canal e provedor.
      required:
        - from_date
        - to_date
        - data
    Error:
      type: object
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - request_id
          properties:
            type:
              type: string
              description: >-
                Categoria do erro: `invalid_request_error`,
                `authentication_error`, `permission_error`, `not_found_error`,
                `conflict_error`, `rate_limit_error`, `billing_error` ou
                `api_error`.
              example: invalid_request_error
            code:
              type: string
              description: >-
                Código estável e legível por máquina. Veja [Códigos de
                erro](/errors/error-codes).
              example: channel_inactive
            message:
              type: string
              description: >-
                Texto para humanos, em inglês. Pode mudar, então não faça parse
                dele.
              example: Channel chan_01J8... is not active and cannot send messages.
            param:
              type: string
              description: O campo da requisição com problema, quando se aplica.
            doc_url:
              type: string
              description: Link para a documentação do código, quando disponível.
            details:
              type: object
              additionalProperties:
                oneOf:
                  - type: string
                  - type: number
              description: >-
                Valores acionáveis, como `limit`, `used` e `resets_at` em
                `message_quota_exceeded`.
            request_id:
              type: string
              description: Identificador da requisição. Informe-o ao falar com o suporte.
              example: req_01J8ZK9M3Q7XABCDEFGHJKMNPQ
          description: Detalhes do erro.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave de API do projeto, no formato `rt_live_...` ou `rt_test_...`,
        enviada como `Authorization: Bearer <chave>`.

````

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