Analytics से डेटा एक्सपोर्ट करना

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

असाइन किए गए सेवा एजेंटों के लिए अनुमतियां सेट अप करना

ऊपर बताए गए बदलावों के लिए, असाइन किए गए सेवा एजेंटों के लिए अनुमतियां सेट अप करने के लिए, यह तरीका अपनाएं.

  1. नीचे दिया गया निर्देश डालकर, Google Cloud सेवा एजेंट का नाम ढूंढें:
    curl -X GET \
      "https://api.enterprise.apigee.com/v1/organizations/ORG" \
      -u email:password \
      | jq -r '.properties.property[] | select(.name=="serviceAgent.analytics") | .value'

    ORG आपके संगठन का है. इससे सेवा एजेंट का नाम और वैल्यू मिलती है. यह जानकारी यहां दी गई है:

    "property" : [
      {
       "name" : "serviceAgent.analytics",
       "value" : "service-9q1ibk@gcp-sa-apigee-uap.iam.gserviceaccount.com"
       },
  2. Google Cloud Console में IAM डैशबोर्ड खोलें.
  3. अपना Google Cloud प्रोजेक्ट चुनें.
  4. IAM पैनल में सबसे ऊपर, जोड़ें पर क्लिक करें.
  5. नए मुख्य खाते फ़ील्ड में, पहले चरण में मिला value डालें. उदाहरण के लिए, पहले चरण में दिखाया गया value, service-9q1ibk@gcp-sa-apigee-uap.iam.gserviceaccount.com है.
  6. +दूसरी भूमिका जोड़ें बटन पर क्लिक करें और ये भूमिकाएं जोड़ें:
    • BigQuery उपयोगकर्ता
    • स्टोरेज एडमिन
  7. सेव करें पर क्लिक करें.

Apigee Analytics का डेटा

Apigee Analytics, आपके एपीआई से मिलने वाले डेटा को इकट्ठा और उसका विश्लेषण करता है. साथ ही, विज़ुअलाइज़ेशन टूल उपलब्ध कराता है. इनमें इंटरैक्टिव डैशबोर्ड, कस्टम रिपोर्ट, और अन्य टूल शामिल हैं. ये टूल, एपीआई प्रॉक्सी परफ़ॉर्मेंस के रुझानों की पहचान करते हैं. अब Apigee Analytics से अपने डेटा रिपॉज़िटरी (जैसे, Google Cloud Storage या Google BigQuery) में Analytics डेटा एक्सपोर्ट करके, इस रिच कॉन्टेंट को अनलॉक किया जा सकता है. इसके बाद, Google BigQuery और TensorFlow की क्वेरी और मशीन लर्निंग की सुविधाओं का इस्तेमाल करके, अपने डेटा का विश्लेषण किया जा सकता है. एक्सपोर्ट किए गए Analytics डेटा को वेब लॉग जैसे अन्य डेटा के साथ भी जोड़ा जा सकता है. इससे आपको अपने उपयोगकर्ताओं, एपीआई, और ऐप्लिकेशन के बारे में नई इनसाइट मिलती हैं.

डेटा एक्सपोर्ट करने का फ़ॉर्मैट

Analytics डेटा को इनमें से किसी एक फ़ॉर्मैट में एक्सपोर्ट करें:

  • कॉमा सेपरेटेड वैल्यू (CSV)

    डिफ़ॉल्ट डेलिमिटर, कॉमा (,) वर्ण होता है. इस्तेमाल किए जा सकने वाले डीलिमिटर वर्णों में कॉमा (,), पाइप (|), और टैब (\t) शामिल हैं. csvDelimiter प्रॉपर्टी का इस्तेमाल करके वैल्यू कॉन्फ़िगर करें. इसके बारे में एक्सपोर्ट अनुरोध प्रॉपर्टी का रेफ़रंस में बताया गया है.

  • JSON (नई लाइन से अलग किया गया)

    इस विकल्प की मदद से, नई लाइन वाले वर्ण को डेलिमिटर के तौर पर इस्तेमाल किया जा सकता है.

एक्सपोर्ट किए गए डेटा में, Edge में पहले से मौजूद सभी Analytics मेट्रिक और डाइमेंशन शामिल होते हैं. साथ ही, इसमें आपके जोड़े गए सभी कस्टम Analytics डेटा भी शामिल होता है. एक्सपोर्ट किए गए डेटा के बारे में जानकारी पाने के लिए, Analytics मेट्रिक, डाइमेंशन, और फ़िल्टर के बारे में जानकारी देखें.

आंकड़ों के डेटा को इन डेटा रिपॉज़िटरी में एक्सपोर्ट किया जा सकता है:

एक्सपोर्ट करने की प्रोसेस के बारे में खास जानकारी

यहां दिए गए तरीके में, आपके Analytics डेटा को एक्सपोर्ट करने की प्रोसेस के बारे में खास जानकारी दी गई है:

  1. डेटा एक्सपोर्ट करने के लिए, अपने डेटा रिपॉज़िटरी को कॉन्फ़िगर करें (Cloud Storage या BigQuery). आपको यह पक्का करना होगा कि आपका डेटा रिपॉज़िटरी सही तरीके से कॉन्फ़िगर किया गया हो. साथ ही, डेटा रिपॉज़िटरी में डेटा लिखने के लिए इस्तेमाल किए गए सेवा खाते के पास सही अनुमतियां हों.

  2. डेटा स्टोर बनाएं. इससे डेटा रिपॉज़िटरी (Cloud Storage या BigQuery) की प्रॉपर्टी तय की जाती हैं. इसमें डेटा रिपॉज़िटरी को ऐक्सेस करने के लिए इस्तेमाल किए गए क्रेडेंशियल भी शामिल होते हैं.

    डेटा स्टोर बनाते समय, डेटा रिपॉज़िटरी के क्रेडेंशियल को Edge Credentials Vault में अपलोड किया जाता है, ताकि उन्हें सुरक्षित तरीके से सेव किया जा सके. इसके बाद, डेटा एक्सपोर्ट करने की सुविधा, उन क्रेडेंशियल का इस्तेमाल करके आपके डेटा रिपॉज़िटरी में डेटा लिखती है.

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

  4. डेटा एक्सपोर्ट एपीआई का इस्तेमाल करके, यह पता लगाएं कि एक्सपोर्ट कब पूरा होगा.

  5. एक्सपोर्ट पूरा होने के बाद, अपने डेटा रिपॉज़िटरी में एक्सपोर्ट किए गए डेटा को ऐक्सेस करें.

इन सेक्शन में, इन चरणों के बारे में ज़्यादा जानकारी दी गई है.

अपने डेटा रिपॉज़िटरी को कॉन्फ़िगर करना

Analytics डेटा एक्सपोर्ट करने की सुविधा, डेटा को Cloud Storage या BigQuery में लिखती है. इसके लिए, आपको यह करना होगा:

  • Google Cloud Platform सेवा खाता बनाएं.
  • सेवा खाते की भूमिका सेट करें, ताकि वह Cloud Storage या BigQuery को ऐक्सेस कर सके.

Cloud Storage या BigQuery के लिए सेवा खाता बनाना

सेवा खाता एक तरह का Google खाता होता है. यह किसी उपयोगकर्ता के बजाय आपके ऐप्लिकेशन का होता है. इसके बाद, आपका ऐप्लिकेशन किसी सेवा को ऐक्सेस करने के लिए, सेवा खाते का इस्तेमाल करता है.

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

कुंजी से जुड़ा सेवा खाता, Google Cloud Platform प्रोजेक्ट का मालिक होना चाहिए. साथ ही, उसके पास Google Cloud Storage बकेट में बदलाव करने का ऐक्सेस होना चाहिए. सेवा कुंजी बनाने और ज़रूरी पेलोड डाउनलोड करने के लिए, Google Cloud Platform के दस्तावेज़ में सेवा खाते की कुंजियां बनाना और उन्हें मैनेज करना लेख पढ़ें.

उदाहरण के लिए, जब पहली बार अपनी कुंजी डाउनलोड की जाती है, तो उसे JSON ऑब्जेक्ट के तौर पर फ़ॉर्मैट किया जाता है:

{ 
  "type": "service_account", 
  "project_id": "myProject", 
  "private_key_id": "12312312", 
  "private_key": "-----BEGIN PRIVATE KEY-----\n...", 
  "client_email": "client_email@developer.gserviceaccount.com", 
  "client_id": "879876769876", 
  "auth_uri": "https://accounts.google.com/organizations/oauth2/auth", 
  "token_uri": "https://oauth2.googleapis.com/token", 
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2", 
  "client_x509_cert_url": "https://www.googleapis.com" 
}

Google Cloud Storage को कॉन्फ़िगर करना

Google Cloud Storage में डेटा एक्सपोर्ट करने से पहले:

  • पक्का करें कि आपके Google Cloud Platform प्रोजेक्ट में BigQuery और Cloud Resource Manager API चालू हों. निर्देशों के लिए, एपीआई चालू करना लेख पढ़ें. Apigee, BigQuery API का इस्तेमाल करके BigQuery Export की सुविधाओं का फ़ायदा उठाता है. ऐसा तब होता है, जब Cloud Storage में डेटा एक्सपोर्ट किया जाता है. साथ ही, Cloud Resource Manager API का इस्तेमाल करके, हर एक्सपोर्ट से पहले अनुमति की जांच की जाती है.
  • पक्का करें कि सेवा खाते को ये भूमिकाएं असाइन की गई हों:

    • BigQuery जॉब यूज़र
    • स्टोरेज ऑब्जेक्ट क्रिएटर
    • स्टोरेज एडमिन (सिर्फ़ डेटा स्टोर के कॉन्फ़िगरेशन की जांच करना में बताए गए तरीके से डेटा स्टोर की जांच करने के लिए ज़रूरी है. अगर यह भूमिका बहुत बड़ी है, तो इसके बजाय किसी मौजूदा भूमिका में storage.buckets.get अनुमति जोड़ी जा सकती है.)

    इसके अलावा, अगर आपको किसी मौजूदा भूमिका में बदलाव करना है या कस्टम रोल बनाना है, तो भूमिका में ये अनुमतियां जोड़ें:

Google BigQuery को कॉन्फ़िगर करना

Google BigQuery में डेटा एक्सपोर्ट करने से पहले:

  • पक्का करें कि आपके Google Cloud Platform प्रोजेक्ट में BigQuery और Cloud Resource Manager API चालू हों. निर्देशों के लिए, एपीआई चालू करना लेख पढ़ें. Apigee, हर एक्सपोर्ट से पहले अनुमति की जांच करने के लिए, Cloud Resource Manager API का इस्तेमाल करता है.
  • पक्का करें कि आपके Google Cloud Platform प्रोजेक्ट में BigQuery API चालू हो. निर्देशों के लिए, एपीआई चालू और बंद करना लेख पढ़ें.
  • पक्का करें कि सेवा खाते को ये भूमिकाएं असाइन की गई हों:

    • BigQuery जॉब यूज़र
    • BigQuery डेटा एडिटर

    अगर आपको किसी मौजूदा भूमिका में बदलाव करना है या कोई कस्टम रोल बनाना है, तो भूमिका में ये अनुमतियां जोड़ें:

    • bigquery.datasets.create
    • bigquery.datasets.get
    • bigquery.jobs.create
    • bigquery.tables.create
    • bigquery.tables.get
    • bigquery.tables.updateData

डेटा स्टोर बनाना

डेटा स्टोर, एक्सपोर्ट किए गए डेटा की रिपॉज़िटरी (Cloud Storage, BigQuery) से कनेक्शन तय करता है. इसमें डेटा रिपॉज़िटरी को ऐक्सेस करने के लिए इस्तेमाल किए गए क्रेडेंशियल भी शामिल होते हैं.

Edge Credentials Vault के बारे में जानकारी

Edge, क्रेडेंशियल वॉल्ट का इस्तेमाल करता है. इससे, एक्सपोर्ट किए गए डेटा की रिपॉज़िटरी को ऐक्सेस करने के लिए इस्तेमाल किए गए क्रेडेंशियल को सुरक्षित तरीके से सेव किया जाता है. अगर किसी सेवा को Edge Credentials Vault में मौजूद क्रेडेंशियल ऐक्सेस करने हैं, तो आपको क्रेडेंशियल उपयोगकर्ता को तय करना होगा.

नीचे दिए गए तरीके से Edge UI का इस्तेमाल करके डेटा स्टोर बनाते समय, Edge क्रेडेंशियल ऐक्सेस करने के लिए इस्तेमाल किया जाने वाला उपभोक्ता अपने-आप बना देता है.

डेटा स्टोर के कॉन्फ़िगरेशन की जांच करना

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

इसके अलावा, डेटा स्टोर बनाने से पहले, उसके कॉन्फ़िगरेशन की जांच करें. टेस्टिंग करना इसलिए ज़रूरी है, क्योंकि बड़े डेटा को एक्सपोर्ट करने की प्रोसेस पूरी होने में ज़्यादा समय लग सकता है. ज़्यादा डेटा डाउनलोड करने से पहले, क्रेडेंशियल और डेटा स्टोर के कॉन्फ़िगरेशन की जांच करके, अपनी सेटिंग से जुड़ी किसी भी समस्या को तुरंत ठीक किया जा सकता है.

अगर टेस्ट पास हो जाता है, तो डेटा स्टोर बनाएं. अगर टेस्ट पूरा नहीं होता है, तो गड़बड़ियों को ठीक करें. इसके बाद, कॉन्फ़िगरेशन को फिर से टेस्ट करें. जांच पूरी होने के बाद ही डेटा स्टोर बनाया जाता है.

टेस्ट की सुविधा चालू करने के लिए, यह ज़रूरी है कि:

  • पक्का करें कि आपके Google Cloud Platform प्रोजेक्ट में Cloud Resource Manager API चालू हो. निर्देशों के लिए, एपीआई चालू और बंद करना लेख पढ़ें.

डेटा स्टोर बनाना

यूज़र इंटरफ़ेस (यूआई) में डेटा स्टोर बनाने के लिए:

  1. संगठन के एडमिन के तौर पर, https://apigee.com/edge में लॉग इन करें और अपना संगठन चुनें.

    NOTE: डेटा स्टोर बनाने के लिए, आपके पास Edge संगठन के एडमिन की भूमिका होनी चाहिए.

  2. बाईं ओर मौजूद नेविगेशन बार में जाकर, एडमिन > Analytics डेटा स्टोर को चुनें. आपको Analytics डेटास्टोर पेज दिखेगा.

  3. + Datastore जोड़ें बटन को चुनें. आपको डेटा स्टोर का टाइप चुनने के लिए कहा जाएगा:

  4. एक्सपोर्ट किए गए डेटा के लिए टारगेट टाइप चुनें:

    • Google Cloud Storage
    • Google BigQuery

    इसके बाद, कॉन्फ़िगरेशन पेज दिखेगा:

  5. डेटा स्टोर का नाम डालें.

  6. डेटा रिपॉज़िटरी को ऐक्सेस करने के लिए इस्तेमाल किया गया क्रेडेंशियल चुनें. उपलब्ध क्रेडेंशियल की एक ड्रॉप-डाउन सूची दिखती है.

    क्रेडेंशियल, डेटा रिपॉज़िटरी के टाइप के हिसाब से होते हैं. ज़्यादा जानकारी के लिए, Cloud Storage या BigQuery के लिए सेवा खाता बनाना लेख पढ़ें.

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

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

      1. क्रेडेंशियल का नाम.
      2. क्रेडेंशियल कॉन्टेंट, JSON सेवा खाते की वह कुंजी होती है जो आपके डेटा रिपॉज़िटरी के लिए खास होती है. इसे Cloud Storage या BigQuery के लिए सेवा खाता बनाएं में बताया गया है.
      3. बनाएं को चुनें.
  7. डेटा रिपॉज़िटरी के टाइप के हिसाब से प्रॉपर्टी डालें:

    • Google Cloud Storage के लिए:
      प्रॉपर्टी ब्यौरा ज़रूरी है?
      प्रोजेक्ट आईडी Google Cloud Platform प्रोजेक्ट आईडी.

      Google Cloud Platform प्रोजेक्ट बनाने के लिए, Google Cloud Platform के दस्तावेज़ में प्रोजेक्ट बनाना और मैनेज करना लेख पढ़ें.

      हां
      बकेट का नाम Cloud Storage में मौजूद उस बकेट का नाम जिसमें आपको Analytics डेटा एक्सपोर्ट करना है. डेटा एक्सपोर्ट करने से पहले, बकेट का मौजूद होना ज़रूरी है.

      Cloud Storage बकेट बनाने के लिए, Google Cloud Platform के दस्तावेज़ में स्टोरेज बकेट बनाना लेख पढ़ें.

      हां
      पथ वह डायरेक्ट्री जिसमें Cloud Storage बकेट में मौजूद ऐनलिटिक्स डेटा को सेव करना है. हां
    • BigQuery के लिए:
      प्रॉपर्टी ब्यौरा ज़रूरी है?
      प्रोजेक्ट आईडी Google Cloud Platform प्रोजेक्ट आईडी.

      Google Cloud Platform प्रोजेक्ट बनाने के लिए, Google Cloud Platform के दस्तावेज़ में प्रोजेक्ट बनाना और मैनेज करना लेख पढ़ें.

      हां
      डेटासेट का नाम उस BigQuery डेटासेट का नाम जिसमें आपको Analytics डेटा एक्सपोर्ट करना है. पक्का करें कि डेटा एक्सपोर्ट करने का अनुरोध करने से पहले, डेटासेट बना लिया गया हो.

      BigQuery डेटासेट बनाने के लिए, Google Cloud Platform के दस्तावेज़ में डेटासेट बनाना और उनका इस्तेमाल करना लेख पढ़ें.

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

    अगर टेस्ट सफल होता है, तो डेटा स्टोर को सेव करें.

    अगर जांच पूरी नहीं होती है, तो सभी समस्याओं को ठीक करें और जांच को फिर से चलाएं. यूज़र इंटरफ़ेस (यूआई) में गड़बड़ी के मैसेज पर कर्सर घुमाएं, ताकि टूलटिप में ज़्यादा जानकारी दिख सके.

  9. कनेक्शन की जांच पास होने के बाद, डेटा स्टोर को सेव करें.

डेटा स्टोर में बदलाव करना

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

  1. संगठन के एडमिन के तौर पर, https://apigee.com/edge में लॉग इन करें और अपना संगठन चुनें.

  2. बाईं ओर मौजूद नेविगेशन बार में जाकर, एडमिन > Analytics डेटा स्टोर को चुनें. आपको Analytics डेटास्टोर पेज दिखेगा.

  3. जिस रिपोर्ट में बदलाव करना है उसके बदलाव किया गया कॉलम पर माउस पॉइंटर घुमाएं. आपको बदलाव करें और मिटाएं आइकॉन दिखेगा.

  4. डेटा स्टोर में बदलाव करें या उसे मिटाएं.

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

    अगर टेस्ट कामयाब होता है, तो आपको अपने डेटा रिपॉज़िटरी में सैंपल डेटा दिखेगा.

    अगर जांच पूरी नहीं होती है, तो सभी समस्याओं को ठीक करें और जांच को फिर से चलाएं.

  6. कनेक्शन की जांच पास होने के बाद, डेटा स्टोर को अपडेट करें.

Analytics डेटा एक्सपोर्ट करना

Analytics डेटा एक्सपोर्ट करने के लिए, /analytics/exports API को POST अनुरोध भेजें. अनुरोध के मुख्य हिस्से में यह जानकारी पास करें:

  • एक्सपोर्ट के अनुरोध का नाम और जानकारी
  • एक्सपोर्ट किए गए डेटा की तारीख सीमा (वैल्यू सिर्फ़ एक दिन की हो सकती है)
  • एक्सपोर्ट किए गए डेटा का फ़ॉर्मैट
  • डेटा स्टोर का नाम
  • क्या संगठन के लिए कमाई करने की सुविधा चालू है

एक्सपोर्ट करने के अनुरोधों के उदाहरण यहां दिए गए हैं. अनुरोध के मुख्य हिस्से की प्रॉपर्टी के बारे में पूरी जानकारी के लिए, एक्सपोर्ट के अनुरोध की प्रॉपर्टी का रेफ़रंस देखें.

POST का जवाब इस फ़ॉर्म में होता है:

{
    "self": "/organizations/myorg/environments/test/analytics/exports/a7c2f0dd-1b53-4917-9c42-a211b60ce35b",
    "created": "2017-09-28T12:39:35Z",
    "state": "enqueued"
}

ध्यान दें कि जवाब में state प्रॉपर्टी को enqueued पर सेट किया गया है. POST अनुरोध, एसिंक्रोनस तरीके से काम करता है. इसका मतलब है कि अनुरोध का जवाब मिलने के बाद भी, यह बैकग्राउंड में चलता रहता है. state के लिए ये वैल्यू इस्तेमाल की जा सकती हैं: enqueued, running, completed, failed.

डेटा एक्सपोर्ट करने के अनुरोध की स्थिति देखने के लिए, self प्रॉपर्टी में मिले यूआरएल का इस्तेमाल करें. इसके बारे में ऐनलिटिक्स एक्सपोर्ट करने के अनुरोध की स्थिति देखना लेख में बताया गया है. अनुरोध पूरा होने पर, जवाब में state प्रॉपर्टी की वैल्यू को completed पर सेट कर दिया जाता है. इसके बाद, अपने डेटा रिपॉज़िटरी में जाकर, आंकड़ों का डेटा ऐक्सेस किया जा सकता है.

पहला उदाहरण: Cloud Storage में डेटा एक्सपोर्ट करना

यहां दिया गया अनुरोध, myorg संगठन के test एनवायरमेंट से, पिछले 24 घंटों का पूरा रॉ डेटा एक्सपोर्ट करता है. कॉन्टेंट को Cloud Storage में JSON फ़ॉर्मैट में एक्सपोर्ट किया जाता है:

curl -X POST -H "Content-Type:application/json" \
"https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -d \
  '{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository"
  }' \
  -u orgAdminEmail:password

self प्रॉपर्टी से मिले यूआरआई का इस्तेमाल करके, नौकरी की स्थिति को मॉनिटर करें. इसके बारे में Analytics एक्सपोर्ट करने के अनुरोध की स्थिति देखना लेख में बताया गया है.

दूसरा उदाहरण: BigQuery में डेटा एक्सपोर्ट करना

नीचे दिए गए अनुरोध में, कॉमा से अलग की गई CSV फ़ाइल को BigQuery में एक्सपोर्ट किया गया है:

curl -X POST -H "Content-Type:application/json"  \
  "https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -d \
  '{
    "name": "Export query results to BigQuery",
    "description": "One-time export to BigQuery",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "csv",
    "csvDelimiter": ",", 
    "datastoreName": "My BigQuery data repository"
  }' \
  -u orgAdminEmail:password

ध्यान दें: एक्सपोर्ट की गई CSV फ़ाइल से, BigQuery में एक टेबल बनती है. इसका प्रीफ़िक्स यह होता है:

<PREFIX>_<EXPORT_DATE>_api_<UUID>_from_<FROM_DATE>_to_<TO_DATE>

self प्रॉपर्टी से तय किए गए यूआरआई का इस्तेमाल करके, नौकरी की स्थिति को मॉनिटर करें. इसके बारे में Analytics के डेटा को एक्सपोर्ट करने के अनुरोध की स्थिति देखना लेख में बताया गया है.

तीसरा उदाहरण: कमाई करने से जुड़ा डेटा एक्सपोर्ट करना

अगर संगठन के किसी एनवायरमेंट में कमाई करने की सुविधा चालू है, तो दो तरह के डेटा एक्सपोर्ट किए जा सकते हैं:

  • स्टैंडर्ड डेटा एक्सपोर्ट, जैसा कि पिछले दो उदाहरणों में दिखाया गया है.
  • रेवेन्यू जनरेट करने से जुड़ा डेटा एक्सपोर्ट करने के लिए, रेवेन्यू जनरेट करने से जुड़ा डेटा एक्सपोर्ट करने की सुविधा.

रेवेन्यू जनरेट करने से जुड़े डेटा को एक्सपोर्ट करने के लिए, अनुरोध पेलोड में "dataset":"mint" तय करें. इस विकल्प को सेट करने के लिए, संगठन और एनवायरमेंट में कमाई करने की सुविधा चालू होनी चाहिए. अगर ऐसा नहीं है, तो पेलोड से dataset प्रॉपर्टी को हटा दें:

  '{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository",
    "dataset":"mint"
  }'

एक्सपोर्ट एपीआई के कोटा के बारे में जानकारी

डेटा एक्सपोर्ट करने के लिए इस्तेमाल किए जाने वाले एपीआई कॉल का ज़्यादा इस्तेमाल रोकने के लिए, Edge, /analytics/exports एपीआई के कॉल पर कोटा लागू करता है:

  • जिन संगठनों और एनवायरमेंट के लिए कमाई करने की सुविधा चालू नहीं है उनके लिए कोटा यह है:

    • हर महीने, हर संगठन/एनवायरमेंट के लिए 70 कॉल.

    उदाहरण के लिए, अगर आपकी कंपनी में दो एनवायरमेंट हैं, prod और test, तो हर एनवायरमेंट के लिए हर महीने 70 एपीआई कॉल किए जा सकते हैं.

  • कमाई करने की सुविधा चालू वाले संगठनों और एनवायरमेंट के लिए, कोटा यह है:

    • हर संगठन और एनवायरमेंट के लिए, हर महीने 70 कॉल स्टैंडर्ड डेटा के लिए.
    • हर संगठन और एनवायरमेंट के लिए, हर महीने 70 कॉल रेवेन्यू जनरेट करने से जुड़े डेटा के लिए.

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

अगर कॉल का कोटा पूरा हो जाता है, तो एपीआई, एचटीटीपी 429 रिस्पॉन्स दिखाता है.

Analytics के सभी एक्सपोर्ट अनुरोधों की स्थिति देखना

Analytics के सभी एक्सपोर्ट अनुरोधों की स्थिति देखने के लिए, /analytics/exports को GET अनुरोध भेजें.

उदाहरण के लिए, यहां दिया गया अनुरोध, myorg संगठन में मौजूद test एनवायरमेंट के लिए, Analytics के सभी एक्सपोर्ट अनुरोधों की स्थिति दिखाता है:

curl -X GET \
  "https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -u email:password

यहां दिए गए उदाहरण में, एक्सपोर्ट के दो अनुरोधों की सूची दिखाई गई है. इनमें से एक अनुरोध को कतार में रखा गया है (बनाया गया है और कतार में है), जबकि दूसरा अनुरोध पूरा हो गया है:

[
  {
    "self":
"/v1/organizations/myorg/environments/test/analytics/exports/e8b8db22-fe03-4364-aaf2-6d4f110444ba",
    "name": "Export results To Cloud Storage",
    "description": "One-time export to Google Cloud Storage",
    "userId": "my@email.com",
    "datastoreName": "My Cloud Storage data store",
    "executionTime": "36 seconds",
    "created": "2018-09-28T12:39:35Z",
    "updated": "2018-09-28T12:39:42Z",
    "state": "enqueued"
  },
  {
    "self":
"/v1/organizations/myorg/environments/test/analytics/exports/9870987089fe03-4364-aaf2-6d4f110444ba"
    "name": "Export raw results to BigQuery",
    "description": "One-time export to BigQuery",
    ... 
  }
]

Analytics के डेटा को एक्सपोर्ट करने के अनुरोध का स्टेटस देखना

Analytics के डेटा को एक्सपोर्ट करने के किसी अनुरोध की स्थिति देखने के लिए, /analytics/exports/{exportId} को GET अनुरोध भेजें. यहां {exportId}, Analytics के डेटा को एक्सपोर्ट करने के अनुरोध से जुड़ा आईडी है.

उदाहरण के लिए, यहां दिया गया अनुरोध, 4d6d94ad-a33b-4572-8dba-8677c9c4bd98 आईडी वाले Analytics एक्सपोर्ट के अनुरोध की स्थिति दिखाता है.

curl -X GET \
"https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98" \
-u email:password

यहां जवाब का एक उदाहरण दिया गया है:

{
  "self":
"/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98",
  "name": "Export results To Cloud Storage",
  "description": "One-time export to Google Cloud Storage",
  "userId": "my@email.com",
  "datastoreName": "My Cloud Storage data store",
  "executionTime": "36 seconds",
  "created": "2018-09-28T12:39:35Z",
  "updated": "2018-09-28T12:39:42Z",
  "state": "enqueued"
}

अगर Analytics एक्सपोर्ट से कोई Analytics डेटा नहीं मिलता है, तो executionTime को "0 सेकंड" पर सेट किया जाता है.

एक्सपोर्ट करने के अनुरोध में प्रॉपर्टी का रेफ़रंस

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

प्रॉपर्टी ब्यौरा ज़रूरी है?
description एक्सपोर्ट करने के अनुरोध का ब्यौरा. नहीं
name एक्सपोर्ट के अनुरोध का नाम. हां
dateRange

एक्सपोर्ट किए जाने वाले डेटा की start और end तारीख को yyyy-mm-dd फ़ॉर्मैट में डालें. उदाहरण के लिए:

"dateRange": {
    "start": "2018-07-29",
    "end": "2018-07-30"
}

dateRange की वैल्यू सिर्फ़ एक दिन की हो सकती है. तारीख की सीमा, start तारीख को 00:00:00 यूटीसी पर शुरू होती है और end तारीख को 00:00:00 यूटीसी पर खत्म होती है.

ध्यान दें: यह पक्का करने के लिए कि पिछले दिन का पूरा डेटा कैप्चर किया गया है, आपको एक्सपोर्ट के अनुरोध का शुरुआती समय बदलना पड़ सकता है. उदाहरण के लिए, 00:05:00 AM यूटीसी.

हां
outputFormat इसे json या csv के तौर पर तय करें. हां
csvDelimiter

अगर outputFormat को csv पर सेट किया गया है, तो CSV आउटपुट फ़ाइल में इस्तेमाल किया गया डीलिमिटर. डिफ़ॉल्ट रूप से, यह , (कॉमा) वर्ण पर सेट होता है. इस्तेमाल किए जा सकने वाले डीलिमिटर वर्णों में कॉमा (,), पाइप (|), और टैब (\t) शामिल हैं.

नहीं
datastoreName उस डेटा स्टोर का नाम जिसमें आपके डेटा स्टोर की परिभाषा शामिल है. हां

उदाहरण के लिए:

{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository"
  }