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

# Uso do espaço

> Conversas, tarefas e eventos por período, e por fonte com group_by=source.



## OpenAPI

````yaml openapi/pt/cell.json GET /v1/usage
openapi: 3.1.0
info:
  title: API de dados da Niadra
  version: '1'
  description: >-
    Escrita, contexto, histórico, objetos, identidade, privacidade e governança
    de um espaço. Cada espaço tem um endereço estável, com o espaço e a região
    no nome.
servers:
  - url: https://{space}.{region}.api.niadra.com
    variables:
      space:
        default: acme-prod
        description: O espaço, que vem na chave de fonte.
      region:
        default: us-east-1
        description: A região do espaço, que também vem na chave.
security: []
paths:
  /v1/usage:
    get:
      tags:
        - usage
      summary: Uso do espaço
      description: >-
        O uso do espaço por hora ou por dia: sessões cobradas, leituras de
        contexto, chamadas ao histórico, eventos recebidos e as demais métricas,
        com o custo em micros. Passe `group_by=source` para separar cada métrica
        por fonte, ou `source_id` para ver uma fonte só.


        **Autenticação.** Token de pessoa do Console com o papel `analysis` (ou
        admin), ou chave de fonte com o escopo `admin`.
      operationId: get_usage_v1_usage_get
      parameters:
        - in: query
          name: since
          required: true
          schema:
            format: date-time
            title: Since
            type: string
          example: '2026-09-22T00:00:00Z'
        - in: query
          name: until
          required: true
          schema:
            format: date-time
            title: Until
            type: string
          example: '2026-09-23T00:00:00Z'
        - in: query
          name: granularity
          required: false
          schema:
            $ref: '#/components/schemas/Granularity'
            default: hour
        - in: query
          name: metric
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                maxItems: 20
                type: array
              - type: 'null'
            title: Metric
          description: >-
            Só estas métricas, como `session_billable`, `context_read`,
            `history_call` ou `event_ingested`. Até 20.
        - in: query
          name: source_id
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            title: Source Id
        - in: query
          name: group_by
          required: false
          schema:
            anyOf:
              - const: source
                type: string
              - type: 'null'
            title: Group By
          description: '`source` separa cada métrica por fonte.'
          example: source
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
              example:
                since: '2026-09-22T00:00:00Z'
                until: '2026-09-23T00:00:00Z'
                granularity: day
                group_by: source
                source_id: null
                items:
                  - start: '2026-09-22T00:00:00Z'
                    metric: session_billable
                    source_id: 0192f79e-11aa-7b20-9f3e-6c1d2e4f5a60
                    quantity: 6120
                    cost_micros: 61200000
                  - start: '2026-09-22T00:00:00Z'
                    metric: session_billable
                    source_id: 0192f79e-11ab-7c31-8e4f-7d2e3f506b71
                    quantity: 1340
                    cost_micros: 13400000
          description: Um item por métrica e período, e por fonte com `group_by=source`.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: >-
            422 `invalid_input`, `verification_not_allowed` ou
            `about_without_link`.
      security:
        - sourceKey: []
        - personToken: []
components:
  schemas:
    Granularity:
      enum:
        - hour
        - day
      title: Granularity
      type: string
    UsageResponse:
      additionalProperties: false
      properties:
        granularity:
          $ref: '#/components/schemas/Granularity'
        group_by:
          anyOf:
            - const: source
              type: string
            - type: 'null'
          title: Group By
        items:
          items:
            $ref: '#/components/schemas/UsageItem'
          title: Items
          type: array
        since:
          format: date-time
          title: Since
          type: string
        source_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Id
        until:
          format: date-time
          title: Until
          type: string
      required:
        - since
        - until
        - granularity
        - items
      title: UsageResponse
      type: object
    Problem:
      additionalProperties: false
      description: >-
        Detalhes do problema no formato da RFC 9457; `code` vem do catálogo de
        erros versionado.
      properties:
        code:
          title: Code
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Detail
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Request Id
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          default: about:blank
          title: Type
          type: string
      required:
        - title
        - status
        - code
      title: Problem
      type: object
    UsageItem:
      additionalProperties: false
      properties:
        cost_micros:
          description: O nosso custo em milionésimos de dólar, quando a métrica tem custo.
          title: Cost Micros
          type: integer
        metric:
          description: '`session_billable`, `context_read`, `event_ingested` e outras.'
          title: Metric
          type: string
        quantity:
          title: Quantity
          type: integer
        source_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Com `group_by=source`: o agente ou o sistema; nulo para o trabalho
            do próprio espaço (exportações, gatilhos, webhooks) e para as horas
            contadas antes de o uso ser guardado por fonte.
          title: Source Id
        start:
          description: Início da hora ou do dia em UTC.
          format: date-time
          title: Start
          type: string
      required:
        - start
        - metric
        - quantity
        - cost_micros
      title: UsageItem
      type: object
  securitySchemes:
    sourceKey:
      type: http
      scheme: bearer
      description: nia_sk_...
    personToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````