रिपोर्ट प्रबंधित करें

Apigee Edge का दस्तावेज़ देखा जा रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी

परिचय

कमाई करने से जुड़ी रिपोर्ट की मदद से, ऐप्लिकेशन के इस्तेमाल से जुड़ी खास जानकारी और लेन-देन की गतिविधि को ऐक्सेस किया जा सकता है. उदाहरण के लिए, यह पता लगाया जा सकता है कि किसी तारीख की सीमा के दौरान, किन ऐप्लिकेशन, डेवलपर, एपीआई प्रॉडक्ट बंडल या एपीआई प्रॉडक्ट के लिए लेन-देन की गतिविधि हुई थी. कमाई करने की सुविधा की मदद से, एपीआई के इस्तेमाल को ट्रैक करने वाली खास जानकारी या ज़्यादा जानकारी वाली रिपोर्ट जनरेट की जा सकती हैं.

कमाई करने से जुड़ी रिपोर्ट के टाइप

कमाई करने से जुड़ी इस तरह की रिपोर्ट जनरेट की जा सकती हैं.

डेटा के रखरखाव के बारे में जानकारी

Apigee Edge के सार्वजनिक क्लाउड में, कमाई करने के लिए डेटा को सेव रखने की सुविधा, प्लान का एनटाइटलमेंट है. कमाई करने के एनटाइटलमेंट देखने के लिए, https://cloud.google.com/apigee/specsheets पर जाएं. अगर आपको एनटाइटलमेंट की अवधि के बाद भी कमाई करने से जुड़ा डेटा सेव रखना है, तो Apigee की बिक्री टीम से संपर्क करें. डेटा को ज़्यादा समय तक सेव रखने की सुविधा, अनुरोध करने के समय चालू की जाती है. इसे बाद में चालू नहीं किया जा सकता, ताकि डेटा को सेव रखने की मूल अवधि से पहले का डेटा शामिल किया जा सके.

डुप्लीकेट लेन-देन के बारे में जानकारी

कमाई करने से जुड़े ट्रांज़ैक्शन की रिपोर्ट की तुलना Analytics के डेटा से करने पर, आपको कुछ डुप्लीकेट ट्रांज़ैक्शन दिख सकते हैं. आम तौर पर, ऐसा हो सकता है. ऐसा इसलिए, क्योंकि कमाई करने की सुविधा देने वाला सिस्टम, हर दिन करोड़ों लेन-देन को प्रोसेस कर सकता है. साथ ही, एक ही समय पर कई लेन-देन को प्रोसेस किया जा सकता है. औसतन, ~0.1% लेन-देन डुप्लीकेट हो सकते हैं.

कमाई करने से जुड़ी रिपोर्ट वाले पेज को एक्सप्लोर करना

कमाई करने से जुड़ी रिपोर्ट का पेज ऐक्सेस करने के लिए, यहां दिया गया तरीका अपनाएं.

रिपोर्ट कॉन्फ़िगर करना

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, रिपोर्ट को कॉन्फ़िगर करें. इसके बारे में नीचे दिए गए सेक्शन में बताया गया है.

रिपोर्ट कॉन्फ़िगर करने का तरीका

Edge यूज़र इंटरफ़ेस (यूआई) या क्लासिक Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, रिपोर्ट कॉन्फ़िगर करें.

बिलिंग रिपोर्ट कॉन्फ़िगर करना

रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:

रिचार्ज किए गए पैसों की रिपोर्ट कॉन्फ़िगर करना

आय की रिपोर्ट कॉन्फ़िगर करना

रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:

रेवेन्यू की खास जानकारी वाली रिपोर्ट में, कस्टम लेन-देन एट्रिब्यूट शामिल करना

लेन-देन रिकॉर्ड करने की नीतियों की मदद से, लेन-देन से जुड़े कस्टम एट्रिब्यूट का डेटा कैप्चर किया जा सकता है. साथ ही, उन कस्टम एट्रिब्यूट को आय की खास जानकारी वाली रिपोर्ट में शामिल किया जा सकता है. अपने संगठन के लिए MINT.SUMMARY_CUSTOM_ATTRIBUTES प्रॉपर्टी सेट करके, कमाई करने से जुड़े डेटाबेस की टेबल में शामिल कस्टम एट्रिब्यूट का डिफ़ॉल्ट सेट तय करें.

इस सुविधा का इस्तेमाल करने के लिए, आपको कुछ सोच-विचार और प्लानिंग करनी होगी. इसलिए, नीचे दी गई बातों को ध्यान में रखें.

अगर आप Cloud के ग्राहक हैं, तो प्रॉपर्टी सेट करने के लिए Apigee Edge की सहायता टीम से संपर्क करें. अगर आप निजी क्लाउड के लिए Apigee Edge के ग्राहक हैं, तो सिस्टम एडमिन के क्रेडेंशियल का इस्तेमाल करके, नीचे दिए गए एपीआई पर पुट अनुरोध का इस्तेमाल करके फ़्लैग सेट करें.

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>"

इस उदाहरण में, एपीआई कॉल की मदद से सुविधा चालू की जाती है और कमाई करने से जुड़े डेटाबेस में partner_id और tax_source कॉलम जोड़े जाते हैं. ध्यान दें कि एपीआई कॉल में कस्टम एट्रिब्यूट का कलेक्शन, यूआरएल में कोड में बदला गया है.

रिपोर्ट में कस्टम लेन-देन एट्रिब्यूट शामिल करने से जुड़ी बातें

• एपीआई की मदद से एट्रिब्यूट बनाने से पहले, यह पक्का कर लें कि आपको किन एट्रिब्यूट का इस्तेमाल करना है. ये डेटाबेस में कॉलम के नाम होते हैं. कस्टम एट्रिब्यूट का डेटा हमेशा यहां सेव होता है.
• हर लेन-देन रिकॉर्ड करने की नीति में, 10 कस्टम एट्रिब्यूट स्लॉट उपलब्ध होते हैं, जैसा कि यहां दी गई इमेज में दिखाया गया है. रिपोर्ट में शामिल किए जाने वाले सभी प्रॉडक्ट के लिए, एक ही एट्रिब्यूट के लिए एक ही नाम और पोज़िशन का इस्तेमाल करें. उदाहरण के लिए, लेन-देन रिकॉर्ड करने की इस नीति में, partner_id और tax_source कस्टम एट्रिब्यूट, चौथे और पांचवें बॉक्स में मौजूद हैं. रिपोर्टिंग में शामिल किए जाने वाले प्रॉडक्ट के लिए, लेन-देन रिकॉर्ड करने की सभी नीतियों में यह उनका नाम और पद होना चाहिए.
  
  

सुविधा चालू करने के बाद, आय की खास जानकारी वाली रिपोर्ट में कस्टम एट्रिब्यूट शामिल करने के लिए, MintCriteria में transactionCustomAttributes जोड़कर, report API का इस्तेमाल करें. शर्तों के कॉन्फ़िगरेशन के विकल्प देखें.

वैरिएंस रिपोर्ट कॉन्फ़िगर करना (अब काम नहीं करती)

रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:

रिपोर्ट जनरेट करना और डाउनलोड करना

रिपोर्ट बनाने के बाद, रिपोर्ट के नतीजों को CSV या ZIP फ़ाइल फ़ॉर्मैट में डाउनलोड किया जा सकता है. CSV या ZIP फ़ाइल को एक साथ या अलग-अलग जनरेट किया जा सकता है.

• सिंक्रोन रिपोर्ट के लिए, रिपोर्ट का अनुरोध किया जाता है. यह अनुरोध तब तक ब्लॉक रहता है, जब तक कि Analytics सर्वर से कोई जवाब नहीं मिल जाता. हालांकि, किसी रिपोर्ट को बहुत ज़्यादा डेटा (उदाहरण के लिए, सैकड़ों जीबी) प्रोसेस करना पड़ सकता है. इसलिए, टाइम आउट की वजह से सिंक की जा रही रिपोर्ट पूरी नहीं हो सकती.

  खास जानकारी रिपोर्ट लेवल पर, सिर्फ़ सिंक्रोनस जनरेशन की सुविधा काम करती है.

• असाइन्सिंक रिपोर्ट के लिए, रिपोर्ट का अनुरोध करें और बाद में नतीजे पाएं. असाइनॉन्स क्वेरी प्रोसेसिंग का इस्तेमाल तब किया जा सकता है, जब:

  • लंबे समय के अंतराल वाली रिपोर्ट का विश्लेषण करना और उन्हें बनाना.
  • अलग-अलग तरह के ग्रुपिंग डाइमेंशन और अन्य सीमाओं के साथ डेटा का विश्लेषण करना, जो क्वेरी को मुश्किल बनाते हैं.
  • जब आपको पता चलता है कि कुछ उपयोगकर्ताओं या संगठनों के लिए डेटा का वॉल्यूम काफ़ी बढ़ गया है, तो क्वेरी मैनेज करना.

  ज़्यादा जानकारी वाली रिपोर्ट के लेवल पर, रिपोर्ट को अलग-अलग समय पर जनरेट किया जा सकता है.

CSV या ZIP फ़ाइल फ़ॉर्मैट में रिपोर्ट जनरेट और डाउनलोड करने के लिए, इनमें से कोई एक काम करें:

1. रिपोर्ट पेज ऐक्सेस करें.
2. कर्सर को उस रिपोर्ट पर ले जाएं जिसे डाउनलोड करना है.

3. बदलाव किए गए कॉलम में, इनमें से किसी एक पर क्लिक करें:

   1. खास जानकारी वाली रिपोर्ट के लिए, आइकॉन या आइकॉन. रिपोर्ट, CSV या ज़िप फ़ाइल में सिंक करके सेव की जाती है.
   2. जॉब सबमिट करें (ज़्यादा जानकारी वाली रिपोर्ट के लिए). असाइनमेंट के साथ-साथ अन्य काम भी शुरू हो जाते हैं.

      1. बदलाव किया गया कॉलम में, जॉब की स्थिति को मॉनिटर करें.

         रिपोर्ट डाउनलोड के लिए तैयार होने पर, डिस्क आइकॉन दिखता है:

         
      2. जॉब पूरा होने के बाद, रिपोर्ट डाउनलोड करने के लिए डिस्क आइकॉन पर क्लिक करें.

यहां खास जानकारी वाली बिलिंग रिपोर्ट के लिए, CSV फ़ाइल का एक उदाहरण दिया गया है.

रिपोर्ट में बदलाव करना

रिपोर्ट में बदलाव करने के लिए:

1. रिपोर्ट पेज ऐक्सेस करें.
2. जिस रिपोर्ट में बदलाव करना है उस पर कर्सर घुमाएं और कार्रवाइयों के मेन्यू में पर क्लिक करें.
3. ज़रूरत के हिसाब से रिपोर्ट कॉन्फ़िगरेशन अपडेट करें.
4. अपडेट की गई रिपोर्ट का कॉन्फ़िगरेशन सेव करने के लिए, रिपोर्ट अपडेट करें पर क्लिक करें.

रिपोर्ट मिटाना

किसी रिपोर्ट को मिटाने के लिए:

1. रिपोर्ट पेज ऐक्सेस करें.
2. कर्सर को उस रिपोर्ट पर ले जाएं जिसे मिटाना है.
3. ऐक्शन मेन्यू में पर क्लिक करें.

एपीआई का इस्तेमाल करके, कमाई से जुड़ी रिपोर्ट मैनेज करना

नीचे दिए गए सेक्शन में, एपीआई का इस्तेमाल करके कमाई करने से जुड़ी रिपोर्ट मैनेज करने का तरीका बताया गया है.

एपीआई का इस्तेमाल करके रिपोर्ट कॉन्फ़िगर करना

पूरे संगठन के लिए रिपोर्ट कॉन्फ़िगर करने के लिए, /organizations/{org_name}/report-definitions पर पोस्ट अनुरोध करें.

किसी खास डेवलपर के लिए रिपोर्ट कॉन्फ़िगर करने के लिए, /organizations/{org_name}/developers/{dev_id}/report-definitions पर एक पोस्ट अनुरोध करें. यहां {dev_id}, डेवलपर की पहचान है.

अनुरोध करते समय, आपको रिपोर्ट का नाम और टाइप बताना होगा. टाइप, इनमें से कोई एक होना चाहिए: BILLING, REVENUE, VARIANCE (अब इस्तेमाल नहीं किया जाता) या PREPAID_BALANCE. इसके अलावा, mintCriteria प्रॉपर्टी में शर्तें तय की जा सकती हैं, ताकि रिपोर्ट को और बेहतर तरीके से कॉन्फ़िगर किया जा सके. आपके पास कई तरह की शर्तें तय करने का विकल्प होता है. इससे, रिपोर्ट को कॉन्फ़िगर करने में आपको ज़्यादा विकल्प मिलते हैं. शर्तों के तौर पर ये चीज़ें बताई जा सकती हैं:

• बिलिंग या प्रीपेड बैलेंस की रिपोर्ट के लिए, रिपोर्ट का बिलिंग महीना
• रेवेन्यू रिपोर्ट के लिए, रिपोर्ट में शामिल लेन-देन का टाइप. जैसे, खरीदारी के लेन-देन, शुल्क के लेन-देन, और रिफ़ंड
• प्रीपेड बैलेंस की रिपोर्ट के लिए, वह डेवलपर जिस पर रिपोर्ट लागू होती है
• आय की रिपोर्ट के लिए, API प्रॉडक्ट बंडल (या API पैकेज), प्रॉडक्ट, किराया प्लान, और ऐसे ऐप्लिकेशन जिन पर यह रिपोर्ट लागू होती है
• रेवेन्यू या वैरिएंस रिपोर्ट के लिए, रिपोर्ट में इस्तेमाल की जाने वाली मुद्रा
• बिलिंग, रिचार्ज बैलेंस या रेवेन्यू रिपोर्ट के लिए, यह जानकारी कि रिपोर्ट खास जानकारी वाली है या पूरी जानकारी वाली
• रेवेन्यू की खास जानकारी वाली रिपोर्ट के लिए, रिपोर्ट में कस्टम लेन-देन एट्रिब्यूट शामिल करें

रिपोर्ट की शर्तों की पूरी सूची के लिए, रिपोर्ट कॉन्फ़िगरेशन के विकल्प देखें.

उदाहरण के लिए, यहां दी गई रिपोर्ट से रेवेन्यू की रिपोर्ट बनती है. इसमें जुलाई 2015 के लेन-देन की गतिविधि की खास जानकारी होती है. इस रिपोर्ट में, transactionTypes प्रॉपर्टी में बताए गए अलग-अलग तरह के लेन-देन शामिल होते हैं. यह रिपोर्ट खास तौर पर, Payment API प्रॉडक्ट बंडल और Payment API प्रॉडक्ट पर लागू होती है. रिपोर्ट की परिभाषा में किसी खास डेवलपर या ऐप्लिकेशन के बारे में नहीं बताया गया है. इसलिए, यह रिपोर्ट सभी डेवलपर और ऐप्लिकेशन पर लागू होती है. साथ ही, currencyOption प्रॉपर्टी को LOCAL पर सेट किया गया है. इसलिए, लागू दर प्लान की मुद्रा का इस्तेमाल करके, रिपोर्ट की हर लाइन दिखेगी. इसके अलावा, groupBy प्रॉपर्टी से यह पता चलता है कि रिपोर्ट के कॉलम को इस क्रम में ग्रुप किया जाएगा: PACKAGE, PRODUCT, DEVELOPER, APPLICATION, और RATEPLAN (इसमें रिपोर्ट में किराया प्लान का नाम और आईडी शामिल है).

$ 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

यहां दी गई जानकारी से, जून 2015 के लिए डेवलपर DEV FIVE की गतिविधि दिखाने वाली ज़्यादा जानकारी वाली बिलिंग रिपोर्ट बनाई जाती है.

$ 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

एपीआई का इस्तेमाल करके रिपोर्ट कॉन्फ़िगरेशन देखना

आपके पास किसी संगठन के लिए, रिपोर्ट का कोई खास कॉन्फ़िगरेशन या सभी रिपोर्ट कॉन्फ़िगरेशन देखने का विकल्प होता है. आपके पास किसी डेवलपर के लिए रिपोर्ट कॉन्फ़िगरेशन देखने का भी विकल्प है.

किसी संगठन के लिए खास रिपोर्ट कॉन्फ़िगरेशन देखने के लिए, /organizations/{org_name}/report-definitions/{report_definition_id} पर GET अनुरोध करें. यहां {report_definition_id}, खास रिपोर्ट कॉन्फ़िगरेशन की पहचान है. रिपोर्ट कॉन्फ़िगरेशन बनाते समय, रिस्पॉन्स में आईडी दिखता है. उदाहरण के लिए:

$ 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

संगठन के लिए रिपोर्ट के सभी कॉन्फ़िगरेशन देखने के लिए, /organizations/{org_name}/report-definitions पर GET अनुरोध करें.

नतीजों को फ़िल्टर और क्रम में लगाने के लिए, ये क्वेरी पैरामीटर इस्तेमाल किए जा सकते हैं:

उदाहरण के लिए, यह फ़ंक्शन संगठन के लिए रिपोर्ट कॉन्फ़िगरेशन दिखाता है. साथ ही, ज़्यादा से ज़्यादा पांच रिपोर्ट कॉन्फ़िगरेशन को वापस लाने की सीमा तय करता है:

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

जवाब कुछ ऐसा दिखना चाहिए (जवाब का सिर्फ़ एक हिस्सा दिखाया गया है):

{
  "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
}

किसी खास डेवलपर के लिए रिपोर्ट कॉन्फ़िगरेशन देखने के लिए, /organizations/{org_name}/developers/{dev_id}/report-definitions पर GET अनुरोध करें. यहां {dev_id}, डेवलपर की पहचान है. अनुरोध करते समय, डेटा को फ़िल्टर और क्रम से लगाने के लिए, ऊपर बताए गए क्वेरी पैरामीटर का इस्तेमाल किया जा सकता है.

उदाहरण के लिए, नीचे दिए गए रिटर्न, किसी डेवलपर के लिए रिपोर्ट कॉन्फ़िगरेशन दिखाते हैं और रिस्पॉन्स को रिपोर्ट के नाम के हिसाब से क्रम में लगाते हैं:

$ 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

एपीआई का इस्तेमाल करके रिपोर्ट कॉन्फ़िगरेशन अपडेट करना

रिपोर्ट कॉन्फ़िगरेशन अपडेट करने के लिए, /organizations/{org_name}/report-definitions/{report_definition_id} पर PUT अनुरोध करें. यहां {report_definition_id}, रिपोर्ट कॉन्फ़िगरेशन की पहचान है. अपडेट करने के लिए, आपको अनुरोध के मुख्य हिस्से में अपडेट की गई कॉन्फ़िगरेशन वैल्यू और रिपोर्ट कॉन्फ़िगरेशन का आईडी बताना होगा. उदाहरण के लिए, यहां दिया गया अनुरोध, रिपोर्ट को खास जानकारी वाली रिपोर्ट में अपडेट करता है (अपडेट की गई प्रॉपर्टी हाइलाइट की गई हैं):

$ 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

जवाब कुछ ऐसा दिखना चाहिए (जवाब का सिर्फ़ एक हिस्सा दिखाया गया है):

{
 "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"
}

एपीआई का इस्तेमाल करके रिपोर्ट कॉन्फ़िगरेशन मिटाना

किसी रिपोर्ट कॉन्फ़िगरेशन को मिटाने के लिए, /organizations/{org_namer}/report-definitions/{report_definition_id} को DELETE अनुरोध भेजें. यहां {report_definition_id}, मिटाए जाने वाले रिपोर्ट कॉन्फ़िगरेशन की पहचान है. उदाहरण के लिए:

$ 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

एपीआई का इस्तेमाल करके रिपोर्ट जनरेट करना

रिपोर्ट को कॉन्फ़िगर करने के बाद, उसे देखने के लिए, कॉमा लगाकर अलग की गई वैल्यू (CSV) वाले फ़ाइल फ़ॉर्मैट में जनरेट किया जा सकता है.

रिपोर्ट जनरेट करने के लिए, organizations/{org_id}/{report_type} पर एक पोस्ट अनुरोध करें. {report_type} में, आपको जिस तरह की रिपोर्ट जनरेट करनी है उसकी जानकारी दी जाती है. इनमें ये शामिल हैं:

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

उदाहरण के लिए, बिलिंग रिपोर्ट जनरेट करने के लिए, organizations/{org_name}/billing-reports पर एक पोस्ट अनुरोध करें.

अनुरोध के मुख्य हिस्से में (किसी भी तरह की रिपोर्ट के लिए), रिपोर्ट के लिए खोज की शर्तें बताएं. खोज के लिए शब्द डालने के लिए, mintCriteria प्रॉपर्टी का इस्तेमाल करें. ज़्यादा जानकारी के लिए, शर्तों के कॉन्फ़िगरेशन के विकल्प देखें.

उदाहरण के लिए, नीचे दिया गया अनुरोध, आय की रिपोर्ट खोजता है. यह खोज, रिपोर्ट शुरू और खत्म होने की तारीखों और लेन-देन के टाइप जैसी अलग-अलग शर्तों के आधार पर की जाती है.

$ 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

अगर कोई गड़बड़ी मिलती है, तो रेवेन्यू रिपोर्ट CSV फ़ाइल फ़ॉर्मैट में जनरेट की जाती है. यहां रिपोर्ट के आउटपुट का एक उदाहरण दिया गया है:

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,

एपीआई का इस्तेमाल करके, आय की रिपोर्ट में डेवलपर के कस्टम एट्रिब्यूट शामिल करना

सिर्फ़ आय की रिपोर्ट के लिए, रिपोर्ट में कस्टम एट्रिब्यूट शामिल किए जा सकते हैं. हालांकि, इसके लिए ज़रूरी है कि डेवलपर के लिए कस्टम एट्रिब्यूट तय किया गया हो. अपने संगठन में डेवलपर जोड़ते समय, कस्टम एट्रिब्यूट तय किए जाते हैं. इस बारे में ऐप्लिकेशन डेवलपर मैनेज करना में बताया गया है.

रेवेन्यू रिपोर्ट में कस्टम एट्रिब्यूट शामिल करने के लिए, organizations/{org_name}/revenue-reports पर एक पोस्ट अनुरोध करें और अनुरोध के मुख्य हिस्से में devCustomAttributes कलेक्शन शामिल करें:

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

ध्यान दें: devCustomAttributes कलेक्शन में, पहले से तय किए गए MINT_* और ADMIN_* एट्रिब्यूट की वैल्यू शामिल न करें.

उदाहरण के लिए, नीचे दिए गए उदाहरण में रिपोर्ट में तीन कस्टम एट्रिब्यूट, BILLING_TYPE, SFID, और ORG_EXT शामिल हैं. हालांकि, ऐसा तब ही होगा, जब डेवलपर के लिए ये एट्रिब्यूट तय किए गए हों:

$ 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

यहां रिपोर्ट आउटपुट का एक उदाहरण दिया गया है. इसमें दो कस्टम एट्रिब्यूट की वैल्यू शामिल हैं:

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,

एपीआई का इस्तेमाल करके लेन-देन की गतिविधि की रिपोर्टिंग करना

किसी संगठन के लेन-देन की गतिविधि देखने के लिए, /organizations/{org_name}/transaction-search पर पोस्ट अनुरोध करें. अनुरोध करते समय, आपको डेटा वापस पाने के लिए ज़रूरी शर्तें बतानी होंगी. शर्तों के तौर पर ये चीज़ें बताई जा सकती हैं:

• एक या उससे ज़्यादा एपीआई प्रॉडक्ट का आईडी, जिनके लिए लेन-देन किए गए थे.
• लेन-देन का बिलिंग महीना और साल.
• लेन-देन जारी करने वाले डेवलपर.
• लेन-देन का टाइप, जैसे कि खरीदारी और सेटअप शुल्क.
• लेन-देन की स्थिति, जैसे कि पूरा हुआ और पूरा नहीं हुआ.

शर्तों की पूरी सूची के लिए, शर्तों के कॉन्फ़िगरेशन के विकल्प देखें.

उदाहरण के लिए, यहां जून 2015 की बिलिंग के लिए, किसी डेवलपर के जारी किए गए लेन-देन की जानकारी दी गई है:

$ 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

यह भी पता लगाया जा सकता है कि किसी तारीख की सीमा के दौरान, किन ऐप्लिकेशन, डेवलपर, एपीआई प्रॉडक्ट बंडल या एपीआई प्रॉडक्ट में लेन-देन की गतिविधि हुई थी. आपको यह जानकारी, हर तरह के ऑब्जेक्ट के लिए अलग-अलग दिखती है. उदाहरण के लिए, खास तौर पर उन ऐप्लिकेशन के बारे में जानकारी देखी जा सकती है जो शुरू और खत्म होने की तारीख के बीच, कमाई करने वाले एपीआई प्रॉडक्ट बंडल में एपीआई ऐक्सेस करते हैं.

लेन-देन की गतिविधि की जानकारी देखने के लिए, इनमें से किसी एक संसाधन के लिए जीईटी अनुरोध करें:

अनुरोध करते समय, आपको तारीख की सीमा के लिए क्वेरी पैरामीटर के तौर पर, शुरू और खत्म होने की तारीख बतानी होगी. उदाहरण के लिए, नीचे दिए गए अनुरोध से उन डेवलपर की जानकारी मिलती है जिन्होंने अगस्त 2015 के दौरान लेन-देन किए हैं.

$ 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

जवाब कुछ ऐसा दिखना चाहिए (जवाब का सिर्फ़ एक हिस्सा दिखाया गया है):

{
  "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"
  }, ...
  ]
}

एपीआई के लिए रिपोर्ट कॉन्फ़िगरेशन के विकल्प

एपीआई के लिए, रिपोर्ट कॉन्फ़िगरेशन के ये विकल्प उपलब्ध हैं:

शर्तों को कॉन्फ़िगर करने के विकल्प

mintCriteria प्रॉपर्टी के ज़रिए रिपोर्ट के लिए, कॉन्फ़िगरेशन के ये विकल्प उपलब्ध हैं:

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

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