Pular para o conteúdo principal
GET
/
v1
/
limits
/
{id}
/
usage
Recuperar Uso do Limite
curl --request GET \
  --url https://tracer.lerian.io/v1/limits/{id}/usage \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>'
{
  "limitId": "019c96a0-0c0d-7915-84b9-e497bfee9916",
  "limitAmount": "50000.00",
  "currentUsage": "15000.00",
  "utilizationPercent": 30,
  "nearLimit": false,
  "resetAt": "2026-01-31T00:00:00Z"
}

Autorizações

​
X-API-Key
string
header
obrigatório

API Key authentication. Used by single-tenant deployments (MULTI_TENANT_ENABLED=false). Sent on every /v1/* request.

Cabeçalhos

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

​
X-API-Key
string
obrigatório

A chave de API para autenticação. Este header é obrigatório para todos os endpoints, exceto verificações de integridade.

​
X-Request-Id
string<uuid>

Um identificador único usado para rastrear cada requisição.

Parâmetros de caminho

​
id
string<uuid>
obrigatório

O identificador único do limite que você deseja recuperar, atualizar ou excluir.

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

Snapshot de uso atual de um limite.

​
limitId
string<uuid>

O identificador do limite.

​
limitAmount
string

Valor total do limite como string decimal (ex.: "50000.00").

​
currentUsage
string

Valor de uso atual como string decimal (soma de todas as transações no período). Retorna "0" para limites PER_TRANSACTION, que não rastreiam uso persistente.

​
utilizationPercent
number<float>

Percentual de utilização (currentUsage / limitAmount * 100).

​
nearLimit
boolean

Verdadeiro se o uso exceder 80% do limite.

​
resetAt
string<date-time> | null

Quando o contador é reiniciado. Nulo para limites PER_TRANSACTION.