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: Gunakan metode GET untuk mengambil metrik untuk sebuah dimensi

Kata kerja: GET
Autentikasi: Autentikasi Dasar
Jenis media:
application/json
Ringkasan: Laporan dibuat menggunakan permintaan GET pada resource API /stats, disertai dengan:
  • Parameter URI opsional yang menentukan dimensi untuk laporan. Apigee menentukan kumpulan dimensi yang telah mengagregasikan dahulu kumpulan metrik berdasarkan 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 entitas yang metrik Platform API-nya harus diambil. Apigee menentukan kumpulan dimensi yang dapat digunakan dalam 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 pada Platform API
  • /stats/developer_email: Alamat email developer yang terdaftar di organisasi pada Platform API
  • /stats/developer_app: Nama aplikasi developer yang membuat permintaan ke API Anda
  • /stats/devs:ID developer unik yang dibuat Edge yang terdaftar dalam organisasi di Platform API
  • /stats/access_token: Token akses OAuth pengguna akhir aplikasi
Pemfilteran

Filter dapat diterapkan ke resource kustom. Resource kustom meliputi:

Simbol Operasi
in untuk penyertaan daftar
notin untuk pengecualian daftar
eq =
ne != atau
gt >
lt
ge >=
le
Filter contoh
Deskripsi Filter struktur kueri
Statistik untuk proxy API bernama api1 atau api2 filter=(apiproxy in 'api1','api2')
Statistik untuk semua proxy API kecuali api1 dan api2 filter=(apiproxy notin 'ap1','api2')
Statistik tanpa 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 (nama proxy API 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 diisi?
pilih Menetapkan metrik yang akan digabungkan untuk laporan. Metrik yang didukung adalah message_count, error_count, total_response_time, max_response_time, min_response_time, data_Exchange_size, end_point_response_time 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 Ketika dua atau beberapa nilai pilih ditentukan, 'sortby' dapat digunakan untuk menentukan pilihan yang digunakan untuk mengurutkan hasil: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time T/A Tidak
sort Cakupan pengurutan yang didukung adalah DESC atau ASC T/A Tidak
Topk Ambil hasil "top k" dari hasil, misalnya, untuk menampilkan 5 hasil teratas "topk=5". T/A Tidak
filter Mengaktifkan lihat perincian 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 offset ke '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)
metrics Nilai yang ditampilkan untuk dimensi yang ditentukan
dimensi Dimensi yang ditentukan untuk pengukuran: dalam contoh ini api_name.
metrics Metrik untuk laporan