> For the complete documentation index, see [llms.txt](https://docs.autentique.com.br/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.autentique.com.br/api/corporate/consulta-de-consumo-de-api-na-organizacao-filha.md).

# 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

```graphql
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

<table data-search="false"><thead><tr><th>Campo</th><th>Descrição</th></tr></thead><tbody><tr><td><code>create_document</code></td><td>Criação de documento.</td></tr><tr><td><code>email</code></td><td>Solicitação de assinatura por e-mail.</td></tr><tr><td><code>sms</code></td><td>Solicitação de assinatura por SMS.</td></tr><tr><td><code>whatsapp</code></td><td>Solicitação de assinatura por WhatsApp.</td></tr><tr><td><code>whatsapp_otp</code></td><td>Código OTP enviado por WhatsApp.</td></tr><tr><td><code>documents_query</code></td><td>Consulta de dados de documentos.</td></tr><tr><td><code>link</code></td><td>Assinatura por link.</td></tr><tr><td><code>sign_phone_security_verification</code></td><td>Validação adicional por telefone.</td></tr><tr><td><code>webhook</code></td><td>Entrega de webhook.</td></tr></tbody></table>

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