Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.useaira.com/llms.txt

Use this file to discover all available pages before exploring further.

Cada evento registra uma ação de consumo feita por um cliente — e é a partir deles que toda a cadeia de cobrança é calculada.
Aira — Listagem de eventos

​
O que são eventos

Um evento é um registro que documenta uma ação de uso realizada por um cliente no seu produto. Pense nele como um recibo digital: ele registra quem usou, o que usou, quando usou e quanto usou. Exemplos do mundo real:
ProdutoEventoO que mede
Plataforma de APIapi_requestCada chamada à API
Cloud storagestorage_usedGB armazenados por dia
Fintechtransaction_processedCada transação financeira processada
Plataforma de IAinference_callCada chamada de inferência ao modelo
Help deskticket_resolvedCada ticket resolvido

​
Estrutura de um evento

Cada evento possui os seguintes campos:
CampoObrigatórioDescrição
idempotencyKeySimChave única que previne processamento duplicado
customerExternalIdSimID externo do cliente que gerou o uso
eventNameSimNome do tipo de uso (ex: api_request, storage_used)
occurredAtSimQuando o uso aconteceu (ISO 8601, UTC)
properties.valueSimQuantidade consumida (inteiro, mínimo 0)
properties.*NãoPropriedades adicionais para filtragem e segmentação
{
  "idempotencyKey": "20240115-acme-api-req-001",
  "customerExternalId": "acme_001",
  "eventName": "api_request",
  "occurredAt": "2024-01-15T14:30:00Z",
  "properties": {
    "value": 250,
    "endpoint": "/v1/payments",
    "method": "POST",
    "status_code": 200
  }
}
Para recursos monetários (valores em dinheiro), envie o valor em centavos — por exemplo, R$ 1.200,50 deve ser enviado como 120050.

​
Origem do evento

Cada evento registra automaticamente como foi criado:
OrigemQuando
APIEvento enviado via endpoint /v1/events/ingest
ImportEvento importado via planilha CSV/Excel
UserEvento criado manualmente pelo Dashboard
Essa informação é útil para auditoria e rastreabilidade.

​
Recálculo de faturas

As faturas são recalculadas diariamente durante a madrugada com os eventos recebidos ao longo do dia. Depois que uma fatura é fechada, ela não é recalculada automaticamente — apenas por ação manual no Dashboard.
Se você precisa corrigir eventos após o fechamento de uma fatura, é possível reabrir a fatura e recalcular os valores manualmente.

​
Próximos passos

  • Enviar eventos — aprenda as diferentes formas de enviar eventos para a Aira
  • Propriedades e idempotência — entenda como usar propriedades adicionais e prevenir duplicatas
  • Recursos — veja como eventos são transformados em métricas de cobrança