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

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

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

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

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

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

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

रिपोर्ट एपीआई की तुलना यूज़र इंटरफ़ेस (यूआई) से करना

कस्टम रिपोर्ट बनाना और मैनेज करना लेख में, कस्टम रिपोर्ट बनाने और चलाने के लिए, Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करने का तरीका बताया गया है. इन रिपोर्ट को एक साथ या अलग-अलग चलाया जा सकता है.

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

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

Apigee हाइब्रिड में सीमाएं

Apigee हाइब्रिड, नतीजे के डेटा सेट पर 30 एमबी की साइज़ सीमा लागू करता है.

एसिंक्रोनस आंकड़ों की क्वेरी बनाने का तरीका

एसिंक्रोनस ऐनलिटिक्स क्वेरी बनाने के लिए, तीन चरण पूरे करने होंगे:

1. क्वेरी सबमिट करें.

2. क्वेरी की स्थिति जानें.

3. क्वेरी के नतीजे फ़ेच करें.

पहला चरण. क्वेरी सबमिट करना

आपको /queries एपीआई को एक पोस्ट अनुरोध भेजना होगा. यह एपीआई, Edge को बैकग्राउंड में आपका अनुरोध प्रोसेस करने के लिए कहता है. अगर क्वेरी सबमिट हो जाती है, तो एपीआई 201 स्टेटस और एक आईडी दिखाता है. इसका इस्तेमाल, बाद के चरणों में क्वेरी को रेफ़र करने के लिए किया जाएगा.

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

curl -X POST -H "Content-Type:application/json"
https://api.enterprise.apigee.com/v1/organizations/myorg/environments/myenv/queries -d @json-query-file
-u orgAdminEmail:password

अनुरोध का मुख्य हिस्सा, क्वेरी का JSON ब्यौरा होता है. JSON बॉडी में, रिपोर्ट के बारे में बताने वाली मेट्रिक, डाइमेंशन, और फ़िल्टर की जानकारी दें.

यहां json-query-file फ़ाइल का उदाहरण दिया गया है:

{ 
   "metrics":  [
     {
         "name": "message_count",
         "function": "sum",
         "alias": "sum_txn"
    }
        ],
    "dimensions": ["apiproxy"],
    "timeRange": "last24hours",
    "limit": 14400,
    "filter":"(message_count ge 0)"         
}

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

रिस्पॉन्स का उदाहरण:

ध्यान दें कि क्वेरी आईडी 9cfc0d85-0f30-46d6-ae6f-318d0cb961bd, रिस्पॉन्स में शामिल है. एचटीटीपी स्टेटस 201 के अलावा, enqueued के state का मतलब है कि अनुरोध पूरा हो गया है.

HTTP/1.1 201 Created

{  
  "self":"/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd",
  "created":"2018-05-10T07:11:10Z",
  "state":"enqueued",
  "error":"false",
}

दूसरा चरण. क्वेरी का स्टेटस पाना

क्वेरी के स्टेटस का अनुरोध करने के लिए, GET कॉल करें. आपको वह क्वेरी आईडी देना होगा जो POST कॉल से मिला था. उदाहरण के लिए:

curl -X GET -H "Content-Type:application/json"
https://api.enterprise.apigee.com/v1/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd
-u email:password

जवाब के सैंपल:

अगर क्वेरी पर अब भी काम चल रहा है, तो आपको इस तरह का जवाब मिलेगा. यहां state की जगह running है:

{
    "self": "/organizations/myorg/environments/myenv/queries/1577884c-4f48-4735-9728-5da4b05876ab",
    "state": "running",
    "created": "2018-02-23T14:07:27Z",
    "updated": "2018-02-23T14:07:54Z"
}

क्वेरी पूरी होने के बाद, आपको ऐसा जवाब दिखेगा, जहां state को completed पर सेट किया गया है:

{
      "self": "/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd",
      "state": "completed",
      "result": {
        "self": "/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result",
        "expires": "2017-05-22T14:56:31Z"
      },
      "resultRows": 1,
      "resultFileSize": "922KB",
      "executionTime": "11 sec",
      "created": "2018-05-10T07:11:10Z",
      "updated": "2018-05-10T07:13:22Z"
}

तीसरा चरण. क्वेरी के नतीजे पाना

क्वेरी की स्थिति completed होने के बाद, नतीजे पाने के लिए नतीजे पाएं एपीआई का इस्तेमाल किया जा सकता है. यहां क्वेरी आईडी फिर से 9cfc0d85-0f30-46d6-ae6f-318d0cb961bd होगा.

curl -X GET -H "Content-Type:application/json" -O -J https://api.enterprise.apigee.com/v1/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result
-u email:password

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

• cURL का इस्तेमाल करने पर, ऊपर दिखाए गए -O -J विकल्पों का इस्तेमाल किया जा सकता है.

• Postman का इस्तेमाल करने पर, आपको सेव करें और डाउनलोड करें बटन चुनना होगा. इस मामले में, response नाम की एक ZIP फ़ाइल डाउनलोड की जाती है.

• Chrome ब्राउज़र का इस्तेमाल करने पर, डाउनलोड अपने-आप स्वीकार हो जाता है.

अगर अनुरोध पूरा हो जाता है और नतीजा सेट शून्य से ज़्यादा होता है, तो नतीजा क्लाइंट पर ज़िप की गई JSON (नई लाइन से अलग की गई) फ़ाइल के तौर पर डाउनलोड किया जाता है. डाउनलोड की गई फ़ाइल का नाम यह होगा:

OfflineQueryResult-<query-id>.zip

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

OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip

ZIP फ़ाइल में, JSON के नतीजों की .gz आर्काइव फ़ाइल होती है. JSON फ़ाइल को ऐक्सेस करने के लिए, डाउनलोड की गई फ़ाइल को अनज़िप करें. इसके बाद, JSON फ़ाइल को निकालने के लिए gzip कमांड का इस्तेमाल करें:

unzip OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip
gzip -d QueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd-000000000000.json.gz

अनुरोध के मुख्य हिस्से के बारे में जानकारी

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

{  
   "metrics":[  
      {  
        "name":"metric_name",
        "function":"aggregation_function",
        "alias":"metric_dispaly_name_in_results",
        "operator":"post_processing_operator",
        "value":"post_processing_operand"
      },
   ...
   ],
   "dimensions":[  
      "dimension_name",
      ...
   ],
   "timeRange":"time_range",
   "limit":results_limit,
   "filter":"filter",
   "groupByTimeUnit": "grouping",
   "outputFormat": "format",
   "csvDelimiter": "delimiter"
}

"metrics":[  
  {  
    "name":"response_processing_latency",
    "function":"avg",
    "alias":"average_response_time_in_seconds",
    "operator":"/",
    "value":"1000"
  }
]

"timeRange": {
    "start": "2018-07-29T00:13:00Z",
    "end": "2018-08-01T00:18:00Z"
}

फ़िल्टर एक्सप्रेशन का सिंटैक्स

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

"filter":"(message_count ge 0)"

(apiproxy in 'ethorapi','weather-api')

(apiproxy in 'ethorapi')

(apiproxy in 'Search','ViewItem')

(response_status_code in 400,401,500,501)

(response_status_code notin 400,401,500,501)

(response_status_code eq 504)

(apiproxy eq 'non-prod')

(response_status_code ne 500)

(apiproxy ne 'non-prod')

(response_status_code gt 500)

(response_status_code lt 500)

(target_response_code ge 400)

(target_response_code le 300)

(apiproxy like '%buy%')

(apiproxy like '%item')

(apiproxy like 'Prod%')

(apiproxy not like '%buy%')

(apiproxy not like '%item')

(apiproxy not like 'Prod%')

(target_response_code gt 399) and (response_status_code ge 400)

(response_size ge 1000) or (response_status_code eq 500)

कंस्ट्रेंट और डिफ़ॉल्ट

यहां एसिंक्रोनस क्वेरी प्रोसेसिंग की सुविधा से जुड़ी सीमाओं और डिफ़ॉल्ट सेटिंग की सूची दी गई है.

क्वेरी के नतीजों के बारे में जानकारी

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

{"message_count":"10209","apiproxy":"guest-auth-v3","hour":"2018-08-07 19:26:00 UTC"}
{"message_count":"2462","apiproxy":"carts-v2","hour":"2018-08-06 13:16:00 UTC"}    
…

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

उदाहरण

पहला उदाहरण: मैसेज की संख्या का योग

पिछले 60 मिनट में मैसेज की कुल संख्या के बारे में क्वेरी.

क्वेरी

curl -X POST -H "Content-Type: application/json" -H "Accept: application/json"
https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/queries"
-d @last60minutes.json
-u orgAdminEmail:password

last60minutes.json से अनुरोध का मुख्य हिस्सा

{  
   "metrics":[  
      {  
         "name":"message_count",
         "function":"sum"
      }
   ],
   "dimensions":[  
      "apiproxy"
   ],
   "groupByTimeUnit":"minute",
   "limit":1000,
   "timeRange":"last60minutes"
}

दूसरा उदाहरण: कस्टम समयसीमा

पसंद के मुताबिक समयसीमा का इस्तेमाल करके क्वेरी करना.

क्वेरी

curl -X POST -H "Content-Type: application/json" -H "Accept: application/json"
https://api.enterprise.apigee.com/v1 /organizations/myorg/environments/test/queries"
-d @last60minutes.json
-u orgAdminEmail:password

last60minutes.json से अनुरोध का मुख्य हिस्सा

{  
   "metrics":[  
      {  
         "name":"message_count",
         "function":"sum"
      },
      {  
         "name":"total_response_time",
         "function":"avg",
         "alias":"average_response_time"
      }
   ],
   "dimensions":[  
      "apiproxy"
   ],
   "groupByTimeUnit":"minute",
   "limit":1000,
   "timeRange":{  
      "start":"2018-11-01T11:00:00Z",
      "end":"2018-11-30T11:00:00Z"
   }
}

तीसरा उदाहरण: हर मिनट में होने वाले लेन-देन

हर मिनट के लेन-देन (tpm) की मेट्रिक के बारे में क्वेरी.

क्वेरी

curl -X POST -H "Content-Type: application/json" -H "Accept: application/json"
https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/queries"
-d @tpm.json
-u orgAdminEmail:password

tpm.json से अनुरोध का मुख्य हिस्सा

{  
   "metrics":[  
      {  
         "name":"tpm"
      }
   ],
   "dimensions":[  
      "apiproxy"
   ],
   "groupByTimeUnit":"minute",
   "limit":1000,
   "timeRange":{  
      "start":"2018-07-01T11:00:00Z",
      "end":"2018-07-30T11:00:00Z"
   }
}

नतीजे का सैंपल

नतीजों की फ़ाइल का कुछ हिस्सा:

{"tpm":149995.0,"apiproxy":"proxy_1","minute":"2018-07-06 12:16:00 UTC"}
{"tpm":149998.0,"apiproxy":"proxy_1","minute":"2018-07-09 15:12:00 UTC"}
{"tpm":3.0,"apiproxy":"proxy_2","minute":"2018-07-11 16:18:00 UTC"}
{"tpm":148916.0,"apiproxy":"proxy_1","minute":"2018-07-15 17:14:00 UTC"}
{"tpm":150002.0,"apiproxy":"proxy_1","minute":"2018-07-18 18:11:00 UTC"}
...

चौथा उदाहरण: फ़िल्टर एक्सप्रेशन का इस्तेमाल करना

बूलियन ऑपरेटर का इस्तेमाल करने वाले फ़िल्टर एक्सप्रेशन वाली क्वेरी.

क्वेरी

curl -X POST -H "Content-Type:application/json"
https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/queries"
-d @filterCombo.json
-u orgAdminEmail:password

filterCombo.json से अनुरोध का मुख्य हिस्सा

{  
   "metrics":[  
      {  
         "name":"message_count",
         "function":"sum"
      },
      {  
         "name":"total_response_time",
         "function":"avg",
         "alias":"average_response_time"
      }
   ],
   "filter":"(apiproxy ne \u0027proxy_1\u0027) and (apiproxy ne \u0027proxy_2\u0027)",
   "dimensions":[  
      "apiproxy"
   ],
   "groupByTimeUnit":"minute",
   "limit":1000,
   "timeRange":{  
      "start":"2018-11-01T11:00:00Z",
      "end":"2018-11-30T11:00:00Z"
   }
}

पांचवां उदाहरण: मेट्रिक पैरामीटर में एक्सप्रेशन पास करना

मेट्रिक पैरामीटर के हिस्से के तौर पर पास की गई एक्सप्रेशन वाली क्वेरी. सिर्फ़ एक ऑपरेटर वाले आसान एक्सप्रेशन का इस्तेमाल किया जा सकता है.

क्वेरी

curl -X POST -H "Content-Type:application/json"
https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/queries" 
-d @metricsExpression.json
-u orgAdminEmail:password

metricsExpression.json से अनुरोध का मुख्य हिस्सा

{  
   "metrics":[  
      {  
         "name":"message_count",
         "function":"sum",
         "operator":"/",
         "value":"7"
      }
   ],
   "dimensions":[  
      "apiproxy"
   ],
   "groupByTimeUnit":"minute",
   "limit":10,
   "timeRange":"last60minutes"
}

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

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

एसिंक्रोनस आंकड़ों की क्वेरी की तरह ही, कमाई करने से जुड़ी रिपोर्ट की एसिंक्रोनस क्वेरी तीन चरणों में की जाती हैं: (1) क्वेरी सबमिट करना, (2) क्वेरी की स्थिति देखना, और (3) क्वेरी के नतीजे पाना.

क्वेरी सबमिट करने के पहले चरण के बारे में यहां बताया गया है.

दूसरा और तीसरा चरण, असाइनॉन्स (एक साथ होने वाली) आंकड़ों की क्वेरी के लिए ठीक वैसा ही है. ज़्यादा जानकारी के लिए, असाइनॉन्स (एक साथ नहीं होने वाली) आंकड़ों की क्वेरी बनाने का तरीका लेख पढ़ें.

एसिंक्रोनस कमाई करने की रिपोर्ट के लिए क्वेरी सबमिट करने के लिए, /mint/organizations/org_id/async-reports को पोस्ट अनुरोध भेजें.

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

/mint/organizations/org_id/async-reports?environment=prod

अनुरोध के मुख्य हिस्से में, खोज के लिए ये शर्तें बताएं.

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

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

curl -H "Content-Type:application/json" -X POST -d \
'{
      "fromDate":"2017-06-01 00:00:00",
      "toDate":"2017-06-30 00:00:00",    
     "productIds": [
        "a_product"
    ],
    "devCriteria": [{
        "id": "AbstTzpnZZMEDwjc",
        "orgId": "myorg"
    }]

 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/async-reports?environment=prod" \
-u orgAdminEmail:password