Apigee Analytics hizmetlerinden bir boyut için metrikleri alma ve filtreleme

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Kaynak Yolu: /environments/{env_name}/stats/{dimension_name}

Açıklama: Bir boyutun metriklerini almak için GET yöntemini kullanın.

Fiil: GET
Auth: Temel kimlik doğrulama
Medya türleri:
application/json
Genel bakış: /stats API kaynağında GET isteği kullanılarak bir rapor oluşturulur. Bu raporla birlikte şunlar gönderilir:
  • Raporun boyutunu tanımlayan isteğe bağlı bir URI parametresi. Apigee, bir dizi boyut tanımlar ve bu boyutlara göre bir dizi metriği önceden toplar. Boyut tanımlanmamışsa (ör. URI parametresi boşsa) belirtilen ortamda bulunan tüm API'ler için bir rapor oluşturulur.
  • Raporun metriklerini, zaman aralığını, zaman aralığını ve filtre/detaylandırma yönlerini tanımlayan bir dizi sorgu parametresi.

dimension_name: API Platform metriklerinin alınması gereken varlığı tanımlayan bir URI parametresi. Apigee, raporlarda kullanılabilecek bir dizi boyut tanımlar. Desteklenen boyutlar şunlardır:

  • /stats/apis: API Platform'daki bir kuruluştaki API proxy'leri
  • /stats/apiproducts: Bir kuruluşta tanımlanan API ürünleri
  • /stats/apps: API'nize istekte bulunan geliştirici uygulamasının adı
  • /stats/client_ip: API Platformu'ndaki API'lere istekte bulunan uygulamaların IP adresleri
  • /stats/developer_email: API Platform'daki bir kuruluşa kayıtlı geliştiricinin e-posta adresi
  • /stats/developer_app: API'nize istekte bulunan geliştirici uygulamasının adı
  • /stats/devs:API Platform'daki bir kuruluşta kayıtlı, Edge tarafından oluşturulan benzersiz geliştirici kimliği
  • /stats/access_token: Uygulama son kullanıcısının OAuth erişim jetonu
Filtreleme

Filtreler özel kaynaklara uygulanabilir. Özel kaynaklar:

Sembol İşlem
in listeye dahil etme için
notin liste hariç tutma için
eq =
ne != veya
gt >
lt
ge >=
le
Örnek filtreler
Açıklama Sorgu yapısını filtreleme
api1 veya api2 olarak adlandırılan API proxy'leriyle ilgili istatistikler filter=(apiproxy in 'api1','api2')
api1 ve api2 dışındaki tüm API proxy'leri için istatistikler filter=(apiproxy notin 'ap1','api2')
Hata olmayan istatistikler filter=(iserror eq 0)
Hata mesajı olmayan veya API proxy'si adının api1 ya da api2 olduğu istatistikler filter=(iserror eq 1) or (apiproxy in 'api1','api2')
(Yanıt kodu 201 veya 301) ve (hata var) ya da (API proxy'si adı api1 veya api2) olan istatistikler filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or (apiproxy in 'api1','api2')

Örnek İstek:

$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/{dimension_name}?"select={metric_name}&timeRange=1/1/2013%2000:00~1/2/2013%2000:00&timeUnit=hour&sortby={metric_name}&sort=DESC&filter=(apiproxy%20in%20'weather','news')" \
-u myname:mypass
Sorgu Parametreleri:
Ad Açıklama Varsayılan Zorunlu mu?
seç Rapor için toplanacak metriği belirtir. Desteklenen metrikler şunlardır: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time Yok Evet
timeRange İstenen aralığın başlangıç ve bitiş zamanı. Tarih biçimi AA/GG/YYYY SS:DD şeklindedir. Örneğin, 1/1/2013%2000:00~1/2/2013%2000:00. Maksimum zaman aralığı 6 aydır. Yok Evet
timeUnit saniye, dakika, saat, gün, hafta, ay, üç ay, yıl, on yıl, yüzyıl, bin yıl Yok Evet
sortby İki veya daha fazla seçim değeri belirtildiğinde, sonuçları sıralamak için kullanılan seçimi belirtmek üzere "sortby" kullanılabilir: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time Yok Hayır
sıralama Desteklenen sıralama kapsamları DESC veya ASC'dir. Yok Hayır
topk Sonuçlardan "en iyi k" sonuçlarını alın. Örneğin, en iyi 5 sonucu döndürmek için "topk=5" kullanın. Yok Hayır
filtre Belirli boyut değerlerinde ayrıntılı incelemeyi etkinleştirir. Yok Hayır
sınır API tarafından döndürülen giriş sayısının sınırını ayarlama Yok Hayır
telafi etmek Sonuçların sayfalandırılmasını sağlamak için sınırlama ile birlikte ofseti kullanın. Örneğin, 11-20 arasındaki sonuçları göstermek için sınırı "10" olarak, dengeyi ise "10" olarak ayarlayın. Yok Hayır
Örnek Yanıt: 
{
  "environments" : [ {
        "dimensions" : [ {
          "metrics" : [ 
                 {
                "name" : "message_count",
                "values" : [ {
                   "timestamp" : 1335241800000,
                   "value" : "1.0"
                 } ]
              } ,
                 {
                 "name" : "error_count",
                 "values" : [ {
                    "timestamp" : 1335241800000,
                    "value" : "0.0"
                   } ]
            } 
              ],
        
               "name" : "api1"
        }, 
            {
          "metrics" : [ 
               {
              "name" : "message_count",
              "values" : [ {
                     "timestamp" : 1335241800000,
                     "value" : "1.0"
                  } ]
             },
                {
                "name" : "error_count",
                "values" : [ {
                      "timestamp" : 1335241800000,
                      "value" : "0.0"
                } ]
            } 
             ],
        
             "name" : "api2"
        } 
          ],
        
         "name" : "test"
      } 
    ],
   "metaData" : {
    }
}
Yanıt Yükü Öğeleri:
Ad Açıklama
meta veri Raporla ilişkili meta veriler
ortamlar İstatistiklerin toplandığı kuruluştaki ortamlar (ortamlar arası istatistik toplama için joker karakter * desteklenir)
metrikler Belirtilen boyut için döndürülen değerler
boyutlar Ölçüm için tanımlanan boyut: Bu örnekte api_name.
metrikler Rapor metrikleri