İçeriğe Geç

Hesap Kullanımı

GET /api/v1/account/usage

Hesap Kullanımı

Aktif API anahtarına bağlı müşterinin mevcut tier bilgisini ve kullanım sayaçlarını döner. Bu uç nokta her kimlik doğrulanmış anahtar için açıktır; ayrı bir tier permission gerektirmez.

Yanıt alanları

Genel

  • customerName — müşteri organizasyonun adı
  • tierName — bağlı olduğunuz tier (Community, Business, Enterprise vb.)
  • globalRateLimit — tier'ınızın saatlik istek hakkı
  • requestsToday — UTC 00:00'dan bu yana atılan başarılı istek sayısı (toplam)
  • requestsThisMonth — ayın başından bu yana atılan istek sayısı (toplam)
  • monthResetAt — bu ayın aylık kotalarının sıfırlanacağı UTC zamanı (her ayın 1'i 00:00 UTC)

Endpoint kırılımı — byEndpoint

Tier'ınızın tanıdığı her permission için bir satır içerir. Sıralama "bu ay en çok kullanılan endpoint başta" şeklindedir.

Her satırda:

  • permissionKey — örn. Api.Documents.List, Api.Library.Semantic
  • label — Türkçe okunabilir etiket (Mevzuat — Anlamlı Arama vb.)
  • monthToDate — bu ay endpoint için atılan başarılı istek sayısı
  • monthlyLimit — endpoint için aylık kota (null ise sınırsız)
  • remainingmonthlyLimit - monthToDate (null ise sınırsız)

Aylık kotalar tier yapılandırmasında endpoint başına override edilebilir. Bir endpoint için kota yoksa monthlyLimit ve remaining null döner; sadece global saatlik limit (globalRateLimit) geçerlidir.

Ne zaman kullanmalı

  • Günlük/aylık kullanımı kendi dashboard'unuza beslemek için
  • Bir endpoint'in kotasının ne kadar kaldığını gerçek zamanlı görmek için (429 QUOTA_EXCEEDED'a yakalanmadan önce)
  • Tier yükseltme kararı almadan önce gerçek hacmi görmek için

Sayaç davranışları

  • Sayaçlar sadece başarılı istekleri içerir — 401/403/429 hataları yok sayılır
  • Sayaç güncellemesi asenkrondur; çok son atılan istekler birkaç saniye gecikmeli görünebilir
  • Aylık kota hesabı UTC takvim ayını kullanır — monthResetAt ile sıfırlanır, lokal saat dilimini dikkate almaz
  • Endpoint başına monthToDate bugünkü canlı sayaç + geçmiş günlerin günlük toplamından derlenir; birkaç saniyeye kadar tutarlılık penceresi vardır

Yanıtlar

200 — Kullanım bilgileri.

{
  "success": true,
  "data": {
    "customerName": "Acme Finans",
    "tierName": "Business",
    "globalRateLimit": 1000,
    "requestsToday": 421,
    "requestsThisMonth": 12873
  },
  "meta": { "requestId": "req_..." }
}

401 — X-API-Key eksik veya geçersiz.