Pular para o conteúdo principal
GET
/
v1
/
limits
/
{limit_id}
/
usage
Recuperar Uso do Limite
curl --request GET \
  --url https://tracer.lerian.io/v1/limits/{limit_id}/usage \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <x-api-key>'
{
  "limitId": "ff1e8400-e29b-41d4-a716-446655440050",
  "limitAmount": 5000000,
  "currentUsage": 1500000,
  "utilizationPercent": 30,
  "nearLimit": false,
  "resetAt": "2026-01-31T00:00:00Z"
}

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

limit_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
integer

Valor total do limite em centavos.

currentUsage
integer

Valor de uso atual em centavos (soma de todas as transações no período). Nulo para limites PER_TRANSACTION.

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.