Voltar à documentação

Revisar Histórico

Veja o histórico de uso e métricas da sua conta de API

por Arkangel AI Team•1 min de leitura

Monitore o uso da sua API e acesse métricas detalhadas da sua conta.

Histórico de Uso

Endpoint

GET https://api.arkangelai.com/v1/usage

Exemplo

curl https://api.arkangelai.com/v1/usage \
  -H "Authorization: Bearer sua_chave_api"

Parâmetros

Parâmetro Tipo Descrição
start_date string Data de início (AAAA-MM-DD)
end_date string Data de fim (AAAA-MM-DD)
granularity string day, week ou month

Resposta

{
  "usage": {
    "period": {
      "start": "2026-01-01",
      "end": "2026-01-19"
    },
    "total_requests": 1250,
    "total_tokens": 45000,
    "successful_requests": 1240,
    "failed_requests": 10
  },
  "daily_breakdown": [
    {
      "date": "2026-01-19",
      "requests": 85,
      "tokens": 3200
    }
  ]
}

Métricas por Endpoint

curl "https://api.arkangelai.com/v1/usage/endpoints?start_date=2026-01-01" \
  -H "Authorization: Bearer sua_chave_api"

Resposta

{
  "endpoints": [
    {
      "endpoint": "/v1/chat",
      "requests": 800,
      "avg_latency_ms": 450,
      "error_rate": 0.5
    },
    {
      "endpoint": "/v1/files",
      "requests": 150,
      "avg_latency_ms": 200,
      "error_rate": 0.2
    }
  ]
}

Limites e Cotas

Verificar Limites Atuais

curl https://api.arkangelai.com/v1/usage/limits \
  -H "Authorization: Bearer sua_chave_api"

Resposta

{
  "plan": "professional",
  "limits": {
    "requests_per_day": 10000,
    "requests_used_today": 85,
    "tokens_per_month": 1000000,
    "tokens_used_this_month": 45000,
    "file_storage_mb": 500,
    "file_storage_used_mb": 125
  },
  "reset_times": {
    "daily": "2026-01-20T00:00:00Z",
    "monthly": "2026-02-01T00:00:00Z"
  }
}

Histórico de Erros

curl "https://api.arkangelai.com/v1/usage/errors?limit=20" \
  -H "Authorization: Bearer sua_chave_api"

Resposta

{
  "errors": [
    {
      "timestamp": "2026-01-19T10:30:00Z",
      "endpoint": "/v1/chat",
      "status_code": 429,
      "error_type": "rate_limit_exceeded",
      "request_id": "req_xyz789"
    }
  ],
  "total": 10
}

Exportar Dados de Uso

Exporte seu histórico de uso para análise:

curl "https://api.arkangelai.com/v1/usage/export?format=csv&start_date=2026-01-01" \
  -H "Authorization: Bearer sua_chave_api" \
  -o uso_api.csv

Formatos Disponíveis

Formato Descrição
csv Valores separados por vírgula
json Dados estruturados JSON

Alertas de Uso

Configure alertas quando você atingir certos limites:

curl -X POST https://api.arkangelai.com/v1/usage/alerts \
  -H "Authorization: Bearer sua_chave_api" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "usage_threshold",
    "threshold_percent": 80,
    "notify_email": "seu@email.com"
  }'

Exemplo Completo

async function getUsageReport() {
  const today = new Date().toISOString().split('T')[0];
  const monthStart = today.substring(0, 8) + '01';

  // Obter uso do mês
  const usageResponse = await fetch(
    `https://api.arkangelai.com/v1/usage?start_date=${monthStart}&end_date=${today}`,
    {
      headers: {
        'Authorization': 'Bearer sua_chave_api'
      }
    }
  );

  const usage = await usageResponse.json();

  // Obter limites
  const limitsResponse = await fetch(
    'https://api.arkangelai.com/v1/usage/limits',
    {
      headers: {
        'Authorization': 'Bearer sua_chave_api'
      }
    }
  );

  const limits = await limitsResponse.json();

  return {
    usage: usage.usage,
    limits: limits.limits,
    percentUsed: (usage.usage.total_tokens / limits.limits.tokens_per_month) * 100
  };
}

Próximos Passos