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

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

शुरुआती जानकारी

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

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

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

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

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

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

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

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

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

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

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

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

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

प्रीपेड बैलेंस की रिपोर्ट को कॉन्फ़िगर करना

रेवेन्यू की रिपोर्ट को कॉन्फ़िगर करना

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

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

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

इस सुविधा का इस्तेमाल करने के लिए, सोच-समझकर और योजना बनाने की ज़रूरत है. इसलिए, यहां दी गई बातों पर ध्यान दें.

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

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 कस्टम एट्रिब्यूट, बॉक्स 4 और 5 पर ले जाते हैं. रिपोर्टिंग में प्रॉडक्ट को शामिल करने के लिए, ट्रांज़ैक्शन रिकॉर्ड करने की सभी नीतियों में यह उनका नाम और स्थिति होनी चाहिए.
  
  

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

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

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

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

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

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

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

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

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

  ज़्यादा जानकारी वाली रिपोर्ट का लेवल, एसिंक्रोनस जनरेशन के साथ काम करता है.

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

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

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

   1. आइकॉन या आइकॉन (खास जानकारी वाली रिपोर्ट के लिए). रिपोर्ट, CSV या zip फ़ाइल में सिंक होती हुई सेव होती है.
   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 प्रॉपर्टी में शर्तें तय की जा सकती हैं. इसके लिए, कई शर्तें तय की जा सकती हैं. इससे, रिपोर्ट को कॉन्फ़िगर करने में काफ़ी आसानी होती है. यहां कुछ ऐसी चीज़ें दी गई हैं जिन्हें शर्तों के तौर पर तय किया जा सकता है:

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

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

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

$ 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 पर जीईटी अनुरोध जारी करें.

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

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

$ 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} के लिए 'मिटाएं' अनुरोध जारी करें. यहां {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",
    ...
]