Documentation Index
Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt
Use this file to discover all available pages before exploring further.
Rapor Türleri
Rapor Üretici oluştururken öncelikle hangi veri kümesi üzerinde raporlama yapılacağı seçilir. Seçilen türe göre sonraki adımlardaki alanlar değişiklik gösterir.| Rapor Türü | Açıklama |
|---|---|
| API Trafik Logları | Log verilerine özel bir sorgu ve filtre eklenerek ham trafik kayıtları üzerinde rapor oluşturulur. |
| Aralıklı API Trafik | API trafiği belirli zaman dilimlerine (saatlik, günlük vb.) göre gruplanarak analiz edilir. |
| API Trafik Metrikleri | API Proxy bazında trafik hacmi, başarı/hata oranları gibi metrikler raporlanır. |
| Endpoint Trafik Metrikleri | Endpoint bazında trafik metrikleri raporlanır. |
| Canary & Mirror Metrikleri | Canary ve Mirror yapılandırmalarına ait trafik metrikleri raporlanır. |
| Endpoint Boyut Metrikleri | Endpoint istek ve yanıt boyutlarına ilişkin metrikler raporlanır. |
| İstemci Trafik Metrikleri | İstemci (credential) bazında trafik metrikleri raporlanır. |
| IP Trafik Metrikleri | IP adresi bazında trafik metrikleri raporlanır. |
| API Proxy Raporu | API Proxy’lerin genel durumu ve bilgileri raporlanır. |
| API Endpoint Raporu | API Endpoint’lerin genel durumu ve bilgileri raporlanır. |
| İnaktif Endpoint’ler | Belirtilen süre içinde istek almayan endpoint’ler listelenir. |
| İnaktif Client’lar | Belirtilen süre içinde istek göndermeyen istemciler listelenir. |
| ACL Raporu | Erişim kontrol listesi (ACL) üzerindeki yetkilendirme durumları raporlanır. |
| Route Çakışma Raporu | Tanımlı rotalar arasındaki çakışmalar tespit edilerek raporlanır. |
| ACL Denetim Kayıtları | ACL üzerinde gerçekleştirilen değişikliklerin denetim kaydı raporlanır. |
Rapor Oluşturma
Tanım
| Alan | Açıklama |
|---|---|
| Aktif | Rapor Üreticinin etkin olup olmadığını belirler. Pasif durumdaki raporlar zamanlanmış olsa da çalıştırılmaz. |
| Rapor Türü | Raporlamanın hangi veri kümesi üzerinde yapılacağını belirler. Seçilen türe göre sonraki adımlar şekillenir. |
| Ad | Rapor Üreticiye verilen benzersiz isimdir. |
| Açıklama | Rapor Üreticinin amacını özetleyen isteğe bağlı açıklama alanıdır. |
| Zamanlama | Raporun hangi sıklıkla otomatik olarak çalıştırılacağı bu bölümde ayarlanır. Cron ifadesi ile dakika, saatlik, günlük ve haftalık gibi zamanlamalar tanımlanabilir. |
Sorgu
Bu adım yalnızca API Trafik Logları rapor türünde görünür.
- Yeni Sorgu — Anlık olarak yeni bir sorgu oluşturulabilir.
- Sorgu Seç — Daha önce tanımlanmış mevcut sorgulardan biri seçilebilir.
Filtre
Raporda hangi log kayıtlarının değerlendirileceği filtre ile belirlenir. Bu adım zorunludur. İki seçenek sunulur:- Yeni Filtre — Anlık olarak yeni bir filtre oluşturulabilir.
- Filtre Seç — Daha önce tanımlanmış mevcut filtrelerden biri seçilebilir.
| Alan | Açıklama |
|---|---|
| Ad | Filtreye verilen isimdir. |
| Proxy Listesi | Raporun hangi API Proxy’ler üzerinde çalıştırılacağını belirler. Seçilmediğinde tüm proxy’ler dahil edilir. |
| Tarih Aralığı | Raporun hangi zaman dilimindeki log kayıtlarını kapsayacağını belirler. Sabitleme (örn. “Bugün”) veya dinamik aralık (örn. “Son 7 gün”) seçilebilir. |
| İşlem Sonuç Tipi | Yalnızca başarılı, hatalı veya engellenmiş isteklerin dahil edilmesi için filtre uygulanabilir. (Yalnızca API Trafik Logları türünde geçerlidir.) |
| Sıralama | Rapor kayıtlarının hangi alana göre ve hangi yönde sıralanacağını belirler. (Yalnızca API Trafik Logları türünde geçerlidir.) |
Rapor Alanları
Bu adım yalnızca API Trafik Logları rapor türünde görünür.
- Common Fields
- Request Fields
- Response Fields
| Alan | Açıklama |
|---|---|
| Created | İsteğin oluşturulduğu tarih ve saat. |
| API Proxy | İsteğin geçtiği API Proxy adı. |
| API Type | API’nin türü (REST, SOAP vb.). |
| API Proxy Revision | Kullanılan API Proxy revizyonu. |
| API Proxy Relative Path | API Proxy’nin göreli yolu. |
| API Proxy Method | İstekte kullanılan HTTP metodu (proxy düzeyinde). |
| Total Time (ms) | İsteğin toplam işlem süresi (milisaniye). |
| Username or Key | İsteği gerçekleştiren kullanıcı adı veya API anahtarı. |
| Cache Hit | İsteğin önbellekten karşılanıp karşılanmadığı. |
Rapor Parametreleri
Seçilen rapor türüne göre ek parametreler görünür. Bu parametreler raporun kapsamını daha ayrıntılı biçimde belirlemeye yarar.| Parametre | İlgili Rapor Türleri | Açıklama |
|---|---|---|
| Projeler | Birden fazla rapor türü | Raporun hangi projeleri kapsayacağını belirler. (Yalnızca Admin kullanıcılarında görünür.) |
| Aralık | Aralıklı API Trafik | Trafik verilerinin gruplanacağı zaman dilimi (dakika, saat, gün vb.). |
| API Proxy Tipi | Çeşitli metrik türleri | Belirli tipteki proxy’lere göre filtreleme yapılmasını sağlar. |
| Oluşturma Tipi | Çeşitli metrik türleri | Proxy oluşturma yöntemine göre filtreleme yapılmasını sağlar. |
| Organizasyonlar | ACL Raporu | Raporun hangi organizasyonları kapsayacağını belirler. |
| Credential’lar | ACL Raporu | Raporun hangi credential’ları kapsayacağını belirler. |
| Sorgu Temeli | ACL Raporu | Raporun API Proxy bazlı mı yoksa organizasyon bazlı mı çalışacağını belirler. |
| API Proxy | API Trafik Metrikleri | Raporun yalnızca belirli bir proxy üzerinde çalışmasını sağlar. |
Ortam
Raporun hangi ortam üzerinde çalıştırılacağı bu adımda seçilir.Elasticsearch tabanlı rapor türlerinde ortam seçimi zorunludur. Seçilen ortamın Elasticsearch entegrasyonunun aktif olması gerekir.
Zamanlama
Raporun otomatik olarak çalıştırılma sıklığı bu bölümde belirlenir. Zamanlama ayarları, cron ifadesi formatında oluşturulur.Eylem
Rapor çalıştırıldığında oluşturulan dosyanın nereye iletileceği bu bölümde tanımlanır. Bir veya birden fazla alıcı eklenebilir. Desteklenen eylem türleri arasında e-posta ve webhook bulunmaktadır. Eylemler hakkında detaylı bilgi için Konnektörler sayfasını inceleyebilirsiniz.Saklama Süresi
Geçmiş rapor çalışmalarına ait sonuç kayıtlarının ne kadar süre tutulacağı bu bölümde belirlenir. Belirtilen sürenin sonunda eski sonuçlar otomatik olarak temizlenir.Raporu Test Etme
Raporu kaydetmeden önce mevcut ayarlarla anlık olarak test etme imkânı sunulur.- API Trafik Logları
- Diğer Rapor Türleri
Sorgu ve filtre tanımlandıktan sonra Sorgula butonu ile seçilen ortam üzerinde sorgu anlık olarak çalıştırılır. Sonuçlar sayfalı tablo görünümünde ekranda listelenir.Sonuçlar Excel olarak dışa aktarılabilir; bu sayede anlık sorgu çıktısı daha ayrıntılı incelenebilir.
Önizlemede yalnızca ilk 10 kayıt gösterilir. Tüm sonuçları görmek için raporu zamanlayarak çalıştırmanız gerekir.
Rapor Sonuçları
Kayıtlı bir rapor üreticinin geçmiş çalışma sonuçları, listeden ilgili kayda tıklanarak açılan detay ekranından görüntülenebilir. Ekranın sağ üst köşesindeki Edit Report Generator bağlantısı ile tanım düzenleme sayfasına geçilebilir.
| Sütun | Açıklama |
|---|---|
| Application Log Time | Raporun çalıştırıldığı tarih ve saat. |
| Size of File | Oluşturulan rapor dosyasının boyutu (byte cinsinden). |
| Result Type | Raporun başarılı mı yoksa hatalı mı tamamlandığını gösterir. |
Tarih Aralığı Filtresi
Sonuçlar, ekranın üst bölümündeki tarih aralığı seçici ile filtrelenebilir. Göreli zaman aralıkları (örn. “Son 1 saat”) ya da sabit tarih aralıkları tanımlanabilir.Sonuç Yönetimi
- Her satırın sağındaki silme ikonu ile tek bir sonuç kaydı silinebilir.
- Tablo başlığındaki Delete All butonu ile o rapor üreticiye ait tüm geçmiş sonuçlar tek seferde temizlenebilir.