Raporları yönetin

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

Giriş

Para kazanma raporları, odaklanmış kullanım bilgilerine ve işlem etkinliğine erişmenizi sağlar. Örneğin, belirli bir tarih aralığında hangi uygulamaların, geliştiricilerin, API ürün paketlerinin veya API ürünlerinin işlem etkinliği olduğunu belirleyebilirsiniz. Para kazanma ile API kullanımını izleyen özet veya ayrıntılı raporlar oluşturabilirsiniz.

Para kazanma raporu türleri

Aşağıdaki para kazanma raporu türlerini oluşturabilirsiniz.

Veri saklama hakkında

Apigee Edge herkese açık bulutta para kazanma verilerinin saklanması, bir plan yararlanma hakkıdır. Para kazanma yararlanma hakları için https://cloud.google.com/apigee/specsheets adresine bakabilirsiniz. Para kazanma verilerinizin, yararlanma hakkı süresi sona erdiğinde saklanmasını istiyorsanız Apigee Satış Ekibi ile iletişime geçin. Genişletilmiş veri saklama özelliği istek anında etkinleştirilir ve orijinal veri saklama süresinden daha önceki verilerin dahil edilmesi için geriye dönük olarak etkinleştirilemez.

Yinelenen işlemler hakkında

Para kazanma işlemi raporlarını Analytics verileriyle karşılaştırırsanız az sayıda yinelenen işlem olduğunu fark edebilirsiniz. Para kazanma sistemi günde birkaç milyon işlemi ve herhangi bir anda birçok işlemin paralel olarak işlenebilmesi nedeniyle bu beklenen bir davranıştır. Ortalama olarak, işlemlerin yaklaşık% 0,1'i kopya olabilir.

Para Kazanma Raporları sayfasını keşfetme

Aşağıda açıklanan şekilde Para Kazanma Raporları sayfasına erişin.

Rapor yapılandırma

Aşağıdaki bölümlerde açıklandığı gibi, kullanıcı arayüzünü kullanarak bir raporu yapılandırın.

Rapor yapılandırma adımları

Edge kullanıcı arayüzü veya Classice Edge kullanıcı arayüzünü kullanarak bir raporu yapılandırın.

Fatura raporunu yapılandırma

Rapor yapılandırma adımlarını uygulayın ve rapor sayfasına aşağıdaki bilgileri girin:

Ön ödemeli bakiye raporunu yapılandırma

Gelir raporu yapılandırma

Rapor yapılandırma adımlarını uygulayın ve rapor sayfasına aşağıdaki bilgileri girin:

Gelir özeti raporlarına özel işlem özelliklerini ekleme

İşlem kaydetme politikaları, işlemlerden özel özellik verilerini yakalamanıza olanak tanır. Bu özel özellikleri özet gelir raporlarına ekleyebilirsiniz. Kuruluşunuz için MINT.SUMMARY_CUSTOM_ATTRIBUTES özelliğini ayarlayarak para kazanma veritabanı tablolarında bulunan varsayılan özel özellik grubunu tanımlayın.

Bu özelliği kullanırken üzerinde biraz düşünüp planlama yapmanızı gerektirir. Bu nedenle, aşağıdaki hususları gözden geçirin.

Bulut müşterisiyseniz mülkü ayarlamak için Apigee Edge Destek Ekibi ile iletişime geçin. Private Cloud için Apigee Edge müşterisiyseniz PUT isteğiyle işareti, Sistem Yöneticisi kimlik bilgileriyle aşağıdaki API'ye ayarlayın.

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

Bu örnekte API çağrısı, özelliği etkinleştirir ve para kazanma veritabanına partner_id ve tax_source sütunlarını ekler. API çağrısındaki özel özellik dizisinin URL kodlamalı olduğunu unutmayın.

Raporlara özel işlem özellikleri eklerken dikkate alınması gereken noktalar

• Kullanmak istediğiniz özellik adlarını API ile oluşturmadan önce bu adlardan emin olun. Bunlar, veritabanındaki sütun adlarıdır ve özel özellik verileri her zaman orada depolanır.
• Aşağıdaki resimde gösterildiği gibi her işlem kaydetme politikasında 10 adet özel özellik yuvası bulunur. Raporlara dahil edilecek ürünlerde aynı özellikler için tamamen aynı özellik adlarını ve konumları kullanın. Örneğin, aşağıdaki işlem kaydetme politikasında partner_id ve tax_source özel özellikleri sırasıyla 4 ve 5. kutuları doldurur. Ürünlerin raporlara dahil edilebilmesi için tüm işlem kaydetme politikalarında söz konusu kişinin adı ve konumu olmalıdır.
  
  

Özelliği etkinleştirdikten sonra özet gelir raporuna özel özellikleri dahil etmek için MintCriteria öğesine transactionCustomAttributes ekleyerek rapor API'sini kullanın. Ölçüt yapılandırma seçenekleri bölümüne bakın.

Varyans raporu yapılandırma (Kullanımdan kaldırıldı)

Rapor yapılandırma adımlarını uygulayın ve rapor sayfasına aşağıdaki bilgileri girin:

Rapor oluşturma ve indirme

Bir rapor oluşturduktan sonra, raporun sonuçlarını CSV veya zip dosyası biçiminde indirebilirsiniz. CSV ya da zip dosyasını eşzamanlı veya eşzamansız olarak oluşturabilirsiniz.

• Eşzamanlı raporlar için rapor isteğini çalıştırırsınız ve istek, analiz sunucusu yanıt verene kadar engellenir. Bununla birlikte, bir raporun büyük miktarda veri (örneğin, 100 GB) işlemesi gerekebileceğinden, zaman aşımı nedeniyle eşzamanlı bir rapor başarısız olabilir.

  Özet rapor düzeyi yalnızca eşzamanlı oluşturmayı destekler.

• Eşzamansız rapor için rapor isteğini çalıştırır ve sonuçları daha sonra alırsınız. Eşzamansız sorgu işlemenin iyi bir alternatif olabileceği bazı durumlar şunlardır:

  • Geniş zaman aralıklarına yayılan raporları analiz etme ve oluşturma
  • Sorguyu karmaşık hale getiren çeşitli gruplandırma boyutları ve diğer kısıtlamalarla verileri analiz etme.
  • Bazı kullanıcılar veya kuruluşlar için veri hacimlerinin önemli ölçüde arttığını tespit ettiğiniz sorguları yönetme.

  Ayrıntılı rapor düzeyi, eşzamansız oluşturmayı destekler.

CSV veya zip dosyası biçiminde bir rapor oluşturmak ve indirmek için aşağıdaki görevlerden birini gerçekleştirin:

1. Raporlar sayfasına erişin.
2. İmleci, indirmek istediğiniz raporun üzerine getirin.

3. Değiştirildi sütunu altında, aşağıdakilerden birini tıklayın:

   1. simgesi veya simgesi (Özet rapor için). Rapor bir CSV veya zip dosyasına eşzamanlı olarak kaydedilir.
   2. İşi gönder (Ayrıntılı rapor için). Eşzamansız iş başlar.

      1. Değiştirildi sütununda işin durumunu izleyin.

         Rapor indirilmeye hazır olduğunda disk simgesi görünür:

         
      2. İş tamamlandıktan sonra, raporu indirmek için disk simgesini tıklayın.

Aşağıda, özet faturalandırma raporu için bir CSV dosyası örneği verilmiştir.

Raporu düzenleme

Bir raporu düzenlemek için:

1. Raporlar sayfasına erişin.
2. İmleci düzenlemek istediğiniz raporun üzerine getirin ve işlemler menüsünde simgesini tıklayın.
3. Rapor yapılandırmasını gerektiği şekilde güncelleyin.
4. Güncellenen rapor yapılandırmasını kaydetmek için Raporu güncelle'yi tıklayın.

Rapor silme

Bir raporu silmek için:

1. Raporlar sayfasına erişin.
2. İmleci, silmek istediğiniz raporun üzerine getirin.
3. İşlemler menüsünde simgesini tıklayın.

API kullanarak para kazanma raporlarını yönetme

Aşağıdaki bölümlerde, API kullanılarak para kazanma raporlarının nasıl yönetileceği açıklanmaktadır.

API'yi kullanarak rapor yapılandırma

Kuruluşun tamamı için rapor yapılandırmak üzere /organizations/{org_name}/report-definitions adresine POST isteği gönderin.

Belirli bir geliştirici için rapor yapılandırmak üzere /organizations/{org_name}/developers/{dev_id}/report-definitions adlı alıcıya bir POST isteği gönderin. Burada {dev_id}, geliştiricinin kimliğidir.

İstekte bulunurken raporun adını ve türünü belirtmeniz gerekir. Tür, şunlardan biridir: BILLING, REVENUE, VARIANCE (desteği sonlandırılmış) veya PREPAID_BALANCE. Ayrıca, mintCriteria özelliğinde, raporu daha ayrıntılı yapılandıran ölçütler belirtebilirsiniz. Belirtebileceğiniz çok sayıda ölçüt vardır. Bu, raporu yapılandırma konusunda size büyük ölçüde esneklik sağlar. Ölçüt olarak belirtebileceğiniz şeylerden bazıları şunlardır:

• Faturalandırma veya ön ödeme bakiyesi raporu için raporun fatura ayıdır
• Bir gelir raporu için raporda yer alan işlemlerin türüdür (ör. satın alma işlemleri, ödeme işlemleri ve geri ödemeler gibi).
• Ön ödemeli bakiye raporu için raporun geçerli olduğu geliştirici
• Bir gelir raporu için raporun geçerli olduğu API ürün paketleri (veya API paketleri), ürünler, ücret planları ve uygulamalar
• Gelir veya varyans raporu için raporun geçerli para birimi
• Faturalandırma, ön ödeme bakiyesi veya gelir raporları için rapor ister özet rapor ister ayrıntılı bir rapor olsun
• Gelir özeti raporu için rapora özel işlem özelliklerini ekleyin.

Rapor ölçütlerinin tam listesi için Rapor yapılandırma seçenekleri bölümüne bakın.

Aşağıdaki örnek, Temmuz 2015'teki işlem etkinliğini özetleyen bir gelir raporu oluşturur. Rapor, transactionTypes özelliğinde belirtilen çeşitli işlem türlerini içerir ve özellikle Payment API ürün paketi ve Payment API ürünü için geçerlidir. Rapor tanımında belirli bir geliştirici veya uygulama belirtilmediğinden rapor, tüm geliştiriciler ve uygulamalar için geçerlidir. currencyOption özelliği LOCAL olarak ayarlandığı için raporun her satırında geçerli ücret planının para birimi kullanılarak gösterilir. Ayrıca groupBy özelliği, rapordaki sütunların şu sırayla gruplandırılacağını belirtir: PACKAGE, PRODUCT, DEVELOPER, APPLICATION ve RATEPLAN (rapora ücret planı adı ve kimliği dahildir).

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

Aşağıda, Haziran 2015 için bir geliştirici DEV FIVE'ın etkinliğini gösteren ayrıntılı bir fatura raporu oluşturulmaktadır.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

API'yi kullanarak rapor yapılandırmalarını görüntüleme

Bir kuruluşa ait belirli bir rapor yapılandırmasını veya tüm rapor yapılandırmalarını görüntüleyebilirsiniz. Her bir geliştiricinin rapor yapılandırmalarını da görüntüleyebilirsiniz.

Bir kuruluşun belirli bir rapor yapılandırmasını görüntülemek için /organizations/{org_name}/report-definitions/{report_definition_id} öğesine bir GET isteği gönderin. Burada {report_definition_id}, belirli rapor yapılandırmasının kimliğidir (kimlik, rapor yapılandırmasını oluşturduğunuzda yanıtta döndürülür). Örneğin:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

Kuruluşun tüm rapor yapılandırmalarını görüntülemek için /organizations/{org_name}/report-definitions adresine GET isteği gönderin.

Sonuçları filtrelemek ve sıralamak için aşağıdaki sorgu parametrelerini aktarabilirsiniz:

Örneğin, aşağıdaki ifadeler kuruluşun rapor yapılandırmalarını döndürür ve alma işlemini en fazla beş rapor yapılandırmasıyla sınırlandırır:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

Yanıt aşağıdaki gibi görünecektir (yanıtın yalnızca bir kısmı gösterilir):

{
  "reportDefinition" : [ {
    "description" : "Test revenue report",
    "developer" : null,
    "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5",
    "lastModified" : "2015-08-27 15:44:03",
    "mintCriteria" : {
      "asXorg" : false,
      "currencyOption" : "LOCAL",
      "fromDate" : "2015-07-01 00:00:00",
      "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ],
      "monetizationPackageIds" : [ "payment" ],
      "productIds" : [ "payment" ],
      "showRevSharePct" : false,
      "showSummary" : true,
      "showTxDetail" : true,
      "showTxType" : false,
      "toDate" : "2015-08-01 00:05:00",
      "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ]
    },
    "name" : "Test revenue report",
    "organization" : {
      ...
    },
    "type" : "REVENUE"
  }, {
    "description" : "June billing report, DEV FIVE",
    "developer" : null,
    "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
    "lastModified" : "2015-08-27 17:13:20",
    "mintCriteria" : {
      "asXorg" : false,
      "billingMonth" : "JUNE",
      "billingYear" : 2015,
      "currencyOption" : "LOCAL",
      "showRevSharePct" : false,
      "showSummary" : false,
      "showTxDetail" : true,
      "showTxType" : false
    },
    "name" : "June billing report, DEV FIVE",
    "organization" : {
      ...
    },
    "type" : "BILLING"
  } ],
  "totalRecords" : 2
}

Belirli bir geliştiricinin rapor yapılandırmalarını görüntülemek için /organizations/{org_name}/developers/{dev_id}/report-definitions adresine GET isteği gönderin. Burada {dev_id}, geliştiricinin kimliğidir. İstekte bulunurken verileri filtrelemek ve sıralamak için yukarıda açıklanan sorgu parametrelerini belirtebilirsiniz.

Örneğin, aşağıdaki işlemler belirli bir geliştiriciye ait rapor yapılandırmalarını döndürür ve yanıtı rapor adına göre sıralar:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ 
-u email:password

API kullanarak rapor yapılandırmasını güncelleme

Bir rapor yapılandırmasını güncellemek için /organizations/{org_name}/report-definitions/{report_definition_id} hedefine bir PUT isteği gönderin. Burada {report_definition_id}, belirli rapor yapılandırmasının tanımıdır. Güncellemeyi yaparken, istek gövdesinde güncellenen yapılandırma değerlerini ve rapor yapılandırmasının kimliğini belirtmeniz gerekir. Örneğin, aşağıdaki istek, raporu özet raporla günceller (güncellenen özellikler vurgulanır):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
       "id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
       "name": "June billing report, DEV FIVE",
       "description": "June billing report, DEV FIVE",
       "type": "BILLING",      
       "mintCriteria":{      
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":false,
         "showSummary":true    
        }     
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

Yanıt aşağıdaki gibi görünecektir (yanıtın yalnızca bir kısmı gösterilir):

{
 "description" : "June billing report, DEV FIVE",
  "developer" : null,
  "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
  "lastModified" : "2015-08-27 17:47:29",
  "mintCriteria" : {
    "asXorg" : false,
    "billingMonth" : "JUNE",
    "billingYear" : 2015,
    "showRevSharePct" : false,
    "showSummary" : true,
    "showTxDetail" : false,
    "showTxType" : false
  },
  "name" : "June billing report, DEV FIVE",
  "organization" : {
    ... 
  },
  "type" : "BILLING"
}

API'yi kullanarak rapor yapılandırmasını silme

Bir rapor yapılandırmasını silmek için /organizations/{org_namer}/report-definitions/{report_definition_id} hedefine bir DELETE isteği gönderin. Burada {report_definition_id}, silinecek rapor yapılandırmasının kimliğidir. Örneğin:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

API kullanarak rapor oluşturma

Bir raporu yapılandırdıktan sonra, görüntülemek için raporu virgülle ayrılmış değerler (CSV) dosyası biçiminde oluşturabilirsiniz.

Rapor oluşturmak için organizations/{org_id}/{report_type} adresine bir POST isteği gönderin. Burada {report_type}, oluşturmak istediğiniz rapor türünü belirtir. Türler şunlardır:

• billing-reports
• revenue-reports
• prepaid-balance-reports
• variance-reports

Örneğin, faturalandırma raporu oluşturmak için organizations/{org_name}/billing-reports adresine POST isteği gönderin.

İstek gövdesinde (tüm rapor türleri için) rapora ilişkin arama ölçütlerini belirtin. Arama ölçütlerini belirtmek için mintCriteria özelliklerini kullanın. Daha fazla ayrıntı için Ölçüt yapılandırma seçenekleri bölümüne bakın.

Örneğin, aşağıdaki istek, rapor başlangıç ve bitiş tarihleri ile işlem türleri gibi çeşitli ölçütlere göre bir gelir raporu arar.

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Gelir raporu bulunursa CSV dosyası biçiminde oluşturulur. Aşağıda rapor çıkışının bir örneği gösterilmektedir:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,

API kullanarak gelir raporlarına geliştirici özel özelliklerini ekleme

Yalnızca gelir raporlarında, özel özellik geliştirici için tanımlanmışsa rapora özel özellikler ekleyebilirsiniz. Kuruluşunuza geliştirici eklerken özel özellikleri, Uygulama geliştiricilerini yönetme bölümünde açıklandığı şekilde tanımlarsınız.

Bir gelir raporuna özel özellikler eklemek için organizations/{org_name}/revenue-reports hedefine bir POST isteği gönderin ve istek gövdesine devCustomAttributes dizisini ekleyin:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Not: devCustomAttributes dizisinde, önceden tanımlanmış MINT_* ve ADMIN_* özelliklerini belirtmeyin.

Örneğin, aşağıdaki örnek, raporda üç özel özellik (BILLING_TYPE, SFID ve ORG_EXT) içerir (geliştirici için tanımlanmışsa):

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"
      ],
      "devCustomAttributes": [
         "BILLING_TYPE",
         "SFID",
         "ORG_EXT"
      ]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Aşağıda, iki özel özelliğin değerlerini içeren bir rapor çıkışı örneği gösterilmektedir:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT 
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,

API'yi kullanarak işlem etkinliğini raporlama

/organizations/{org_name}/transaction-search adlı kuruluşa POST isteği göndererek kuruluşun işlem etkinliğini görüntüleyebilirsiniz. İstekte bulunurken alma kriterleri belirtmeniz gerekir. Ölçüt olarak belirtebileceğiniz şeylerden bazıları şunlardır:

• İşlem yapılan bir veya daha fazla API ürününün kimliği.
• İşlemlerin fatura ayı ve yılı.
• İşlemi yapan geliştiriciler.
• İşlemin türü (ör. satın alma ve kurulum ücretleri).
• İşlemin "Başarılı" ve "Başarısız" gibi durumu.

Ölçütlerin tam listesi için Ölçüt yapılandırma seçenekleri bölümüne bakın.

Örneğin, aşağıdaki örnek, Haziran 2015 faturalandırma ayı için belirli bir geliştirici tarafından gerçekleştirilen işlemleri döndürür:

$ curl -H "Content-Type:application/json" -X POST -d \
 '{        
    "billingMonth": "JUNE",
    "billingYear": 2015,
    "devCriteria": [{
      "id": "RtHAeZ6LtkSbEH56",
      "orgId":"myorg"}],
    "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
    "transactionStatus": ["SUCCESS", "FAILED"]
    }'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password

Ayrıca, belirli bir tarih aralığında hangi uygulamaların, geliştiricilerin, API ürün paketlerinin veya API ürünlerinin işlem etkinliği olduğunu da belirleyebilirsiniz. Bu bilgileri her nesne türü için ayrı ayrı görürsünüz. Örneğin, belirli bir başlangıç ve bitiş tarihi içinde para kazandıran API ürün paketlerinizdeki API'lere erişen uygulamalarla ilgili bilgileri görüntüleyebilirsiniz.

İşlem etkinliğiyle ilgili bilgileri görüntülemek için aşağıdaki kaynaklardan birine GET isteği gönderin:

İsteği gönderirken sorgu parametreleri olarak tarih aralığı için bir başlangıç tarihi ve bitiş tarihi belirtmeniz gerekir. Örneğin, aşağıdaki istek Ağustos 2015'te yapılan işlemleri olan geliştiricileri döndürür.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

Yanıt aşağıdaki gibi görünecektir (yanıtın yalnızca bir kısmı gösterilir):

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

API için rapor yapılandırma seçenekleri

API'de aşağıdaki rapor yapılandırma seçenekleri kullanılabilir:

Ölçüt yapılandırma seçenekleri

mintCriteria özelliği aracılığıyla raporlarda aşağıdaki yapılandırma seçenekleri kullanılabilir:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]