Consulta de consumo de API na organização filha

Retornar informações sobre o custo e consumo diário da API.

Visão geral

A query childOrganizationsApiUsage consulta o uso da API pelas organizações filhas. Ela retorna:

• os preços das operações;

• o uso registrado por dia;

• os valores separados por tipo de operação.

Como usar a query

query {
  childOrganizationsApiUsage(
    organization_id: 123
    start_date: "2026-08-01"
    end_date: "2026-08-24"
  ) {
    pricing {
      valid_since
      currency
      items {
        create_document
        email
        sms
        whatsapp
        whatsapp_otp
        documents_query
        link
        sign_phone_security_verification
        webhook
      }
    }
    usage {
      day
      items {
        create_document
        email
        sms
        whatsapp
        whatsapp_otp
        documents_query
        link
        sign_phone_security_verification
        webhook
      }
    }
  }
}

Parâmetros

Parâmetro	Descrição
organization_id	ID da organização filha. Use esse campo para consultar uma organização específica.
start_date	Data e hora inicial do período.
end_date	Data e hora final do período.

Use as datas no formato AAAA-MM-DD, por exemplo: 2026-08-01.

Retorno

pricing

Apresenta os preços das operações no período.

Campo	Descrição
valid_since	Data a partir da qual o preço é válido.
currency	Moeda do preço, como BRL ou USD.
items	Preço de cada operação.

usage

Apresenta o uso separado por dia.

Campo	Descrição
day	Dia do uso.
items	Uso de cada operação naquele dia.

Operações disponíveis

Campo	Descrição
create_document	Criação de documento.
email	Solicitação de assinatura por e-mail.
sms	Solicitação de assinatura por SMS.
whatsapp	Solicitação de assinatura por WhatsApp.
whatsapp_otp	Código OTP enviado por WhatsApp.
documents_query	Consulta de dados de documentos.
link	Assinatura por link.
sign_phone_security_verification	Validação adicional por telefone.
webhook	Entrega de webhook.

Os campos de items podem retornar null quando não houver valor para determinada operação.