Mengambil dan memfilter metrik untuk dimensi dari layanan Apigee Analytics

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Jalur Dasar Platform API: https://api.enterprise.apigee.com/v1/o/{org_name}

Jalur Resource API: /environments/{env_name}/stats/{dimension_name}

Deskripsi: Menggunakan metode GET untuk mengambil metrik untuk sebuah dimensi

Kata kerja: DAPATKAN
Autentikasi: Auth Dasar
Jenis media:
aplikasi/json
Ringkasan: Laporan dibuat menggunakan permintaan GET di /stats API disertai dengan:
  • Parameter URI opsional yang menentukan dimensi untuk laporan. Apigee menentukan kumpulan dimensi, pra-gabungan kumpulan metrik terhadap dimensi tersebut. Jika tidak ada dimensi yang ditentukan (yaitu, jika parameter URI kosong), laporan akan dibuat untuk semua API yang ada di lingkungan yang ditentukan.
  • Kumpulan parameter kueri yang menentukan metrik, rentang waktu, interval waktu, dan aspek filter/lihat perincian laporan.

dimension_name: Parameter URI yang menentukan entity yang mendapatkan API Metrik platform harus diambil. Apigee menentukan kumpulan dimensi yang dapat digunakan laporan. Dimensi yang didukung mencakup:

  • /stats/apis: Proxy API dalam organisasi di Platform API
  • /stats/apiproducts: Produk API yang ditentukan dalam organisasi
  • /stats/apps: Nama aplikasi developer yang membuat permintaan ke API Anda
  • /stats/client_ip: Alamat IP aplikasi yang membuat permintaan ke API di API Peron
  • /stats/developer_email: Alamat email developer yang terdaftar di organisasi di platform API
  • /stats/developer_app: Nama aplikasi developer yang membuat permintaan kepada API Anda
  • /stats/devs:ID developer unik yang dibuat Edge yang terdaftar di organisasi di platform API
  • /stats/access_token: Token akses OAuth pengguna akhir aplikasi
Pemfilteran

Filter dapat diterapkan ke resource kustom. Resource kustom:

Simbol Operasi
in untuk pencantuman daftar
notin untuk pengecualian daftar
eq =
ne != atau
gt >
lt
ge >=
le
Contoh filter
Deskripsi Struktur kueri filter
Statistik untuk proxy API yang bernama api1 atau api2 filter=(apiproxy in 'api1','api2')
Statistik untuk semua proxy API kecuali api1 dan api2 filter=(apiproxy notin 'ap1','api2')
Statistik yang tidak memiliki error filter=(iserror eq 0)
Statistik ketika tidak ada pesan error atau nama proxy API adalah api1 atau api2 filter=(iserror eq 1) or (apiproxy in 'api1','api2')
Statistik di mana (kode respons adalah 201 atau 301) dan (ada error) atau (proxy API namanya adalah api1 atau api2) filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or (apiproxy in 'api1','api2')

Contoh Permintaan:

$ 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
Parameter Kueri:
Nama Deskripsi Default Wajib?
pilih Menentukan metrik yang akan digabungkan untuk laporan. Metrik yang didukung adalah message_count, error_count, total_response_time, max_response_time, min_response_time,, {i>data_ exchange_size<i}, {i>end_point_response_time<i} T/A Ya
timeRange Waktu mulai dan berakhir untuk interval yang diinginkan. Format tanggalnya adalah BB/HH/TTTT JJ:MM. Misalnya, 1/1/2013%2000:00~1/2/2013%2000:00. Rentang waktu maksimum adalah 6 bulan T/A Ya
timeUnit detik, menit, jam, hari, minggu, bulan, kuartal, tahun, dekade, abad, milenium T/A Ya
Mengurutkan Jika dua atau lebih nilai select ditentukan, 'sortby' dapat digunakan untuk menentukan pilih digunakan untuk mengurutkan hasil: message_count, error_count, total_response_time, max_response_time, min_response_time, data_swap_size, end_point_response_time T/A Tidak
mengurutkan Cakupan pengurutan yang didukung adalah DESC atau ASC T/A Tidak
topk Ambil "top k" hasil dari hasil, misalnya, untuk mengembalikan 5 hasil teratas "topk=5". T/A Tidak
filter Mengaktifkan lihat perincian pada nilai dimensi tertentu T/A Tidak
batas Menetapkan batas jumlah entri yang ditampilkan oleh API T/A Tidak
offset Gunakan offset dengan batas untuk mengaktifkan penomoran halaman hasil. Misalnya, untuk menampilkan hasil 11-20, tetapkan batas ke '10' dan offsetnya menjadi '10'. T/A Tidak
Contoh Respons: 
{
  "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" : {
    }
}
Elemen Payload Respons:
Nama Deskripsi
metadata Metadata yang terkait dengan laporan
lingkungan Lingkungan di organisasi tempat statistik dikumpulkan (mendukung karakter pengganti * untuk pengumpulan statistik lintas lingkungan)
metrik Nilai yang ditampilkan untuk dimensi yang ditentukan
dimensi Dimensi yang ditentukan untuk pengukuran: dalam contoh ini api_name.
metrik Metrik untuk laporan