অ্যাসিঙ্ক্রোনাস কাস্টম রিপোর্ট API ব্যবহার করুন

আপনি Apigee Edge-এর ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন .info- তে যান।

এজ অ্যানালিটিক্স বিভিন্ন ধরনের ইন্টারেক্টিভ ড্যাশবোর্ড, কাস্টম রিপোর্ট জেনারেটর এবং সংশ্লিষ্ট সুবিধা প্রদান করে। তবে, এই ফিচারগুলো ইন্টারেক্টিভ হওয়ার জন্যই তৈরি করা হয়েছে: আপনি একটি এপিআই (API) বা ইউআই (UI) অনুরোধ জমা দেন এবং অ্যানালিটিক্স সার্ভার থেকে প্রতিক্রিয়া না পাওয়া পর্যন্ত অনুরোধটি ব্লক হয়ে থাকে।

তবে, অ্যানালিটিক্স অনুরোধগুলি সম্পূর্ণ হতে খুব বেশি সময় নিলে টাইম আউট হতে পারে। যদি কোনো কোয়েরি অনুরোধকে বিপুল পরিমাণ ডেটা (উদাহরণস্বরূপ, কয়েকশ জিবি) প্রসেস করতে হয়, তাহলে টাইম আউটের কারণে এটি ব্যর্থ হতে পারে।

অ্যাসিঙ্ক্রোনাস কোয়েরি প্রসেসিং আপনাকে খুব বড় ডেটা সেটের জন্য কোয়েরি করতে এবং পরবর্তীতে ফলাফল পুনরুদ্ধার করতে দেয়। যখন আপনি দেখবেন যে আপনার ইন্টারেক্টিভ কোয়েরিগুলোর সময়সীমা শেষ হয়ে যাচ্ছে, তখন আপনি একটি অফলাইন কোয়েরি ব্যবহার করার কথা ভাবতে পারেন। কিছু পরিস্থিতি যেখানে অ্যাসিঙ্ক্রোনাস কোয়েরি প্রসেসিং একটি ভালো বিকল্প হতে পারে, তার মধ্যে রয়েছে:

• দীর্ঘ সময়কাল জুড়ে থাকা প্রতিবেদন বিশ্লেষণ ও তৈরি করা।
• বিভিন্ন গ্রুপিং ডাইমেনশন এবং অন্যান্য সীমাবদ্ধতা ব্যবহার করে ডেটা বিশ্লেষণ করা, যা কোয়েরিতে জটিলতা যোগ করে।
• যখন দেখা যায় যে কিছু ব্যবহারকারী বা প্রতিষ্ঠানের জন্য ডেটার পরিমাণ উল্লেখযোগ্যভাবে বৃদ্ধি পেয়েছে, তখন কোয়েরিগুলি পরিচালনা করা।

এই ডকুমেন্টে বর্ণনা করা হয়েছে কিভাবে এপিআই (API) ব্যবহার করে অ্যাসিঙ্ক্রোনাস কোয়েরি শুরু করতে হয়। আপনি ইউআই (UI)-ও ব্যবহার করতে পারেন, যেমনটি 'একটি কাস্টম রিপোর্ট চালানো' অংশে বর্ণনা করা হয়েছে।

রিপোর্ট এপিআই-কে ইউআই-এর সাথে তুলনা করা

কাস্টম রিপোর্ট তৈরি ও পরিচালনা অংশে বর্ণনা করা হয়েছে কীভাবে Edge UI ব্যবহার করে কাস্টম রিপোর্ট তৈরি ও চালানো যায়। আপনি সেই রিপোর্টগুলো সিনক্রোনাসলি বা অ্যাসিনক্রোনাসলি চালাতে পারেন।

UI ব্যবহার করে কাস্টম রিপোর্ট তৈরির বেশিরভাগ ধারণা API ব্যবহারের ক্ষেত্রেও প্রযোজ্য। অর্থাৎ, API দিয়ে কাস্টম রিপোর্ট তৈরি করার সময় আপনি Edge-এর বিল্ট-ইন মেট্রিক , ডাইমেনশন ও ফিল্টার এবং StatisticsCollector পলিসি ব্যবহার করে আপনার তৈরি করা যেকোনো কাস্টম মেট্রিক নির্দিষ্ট করে দেন।

UI এবং API-এর মাধ্যমে তৈরি রিপোর্টগুলোর মধ্যে প্রধান পার্থক্য হলো, API-এর মাধ্যমে তৈরি রিপোর্টগুলো UI-তে প্রদর্শিত ভিজ্যুয়াল রিপোর্টের পরিবর্তে CSV বা JSON (নিউলাইন ডিলিমিটেড) ফাইলে লেখা হয়।

অ্যাপিজি হাইব্রিডে সীমাবদ্ধতা

Apigee hybrid ফলাফল ডেটা সেটের উপর ৩০ মেগাবাইট আকারের সীমা আরোপ করে।

কীভাবে একটি অ্যাসিঙ্ক্রোনাস অ্যানালিটিক্স কোয়েরি তৈরি করবেন

আপনি তিনটি ধাপে অ্যাসিঙ্ক্রোনাস অ্যানালিটিক্স কোয়েরি তৈরি করেন:

1. প্রশ্নটি জমা দিন ।

2. কোয়েরির অবস্থা জানুন ।

3. কোয়েরির ফলাফল পুনরুদ্ধার করুন ।

ধাপ ১. কোয়েরিটি জমা দিন।

আপনাকে অবশ্যই /queries API-তে একটি POST রিকোয়েস্ট পাঠাতে হবে। এই API-টি Edge-কে আপনার রিকোয়েস্টটি ব্যাকগ্রাউন্ডে প্রসেস করতে নির্দেশ দেয়। কোয়েরিটি সফলভাবে সাবমিট হলে, API-টি একটি 201 স্ট্যাটাস এবং একটি ID রিটার্ন করে, যা আপনি পরবর্তী ধাপগুলোতে কোয়েরিটিকে উল্লেখ করার জন্য ব্যবহার করবেন।

উদাহরণস্বরূপ:

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 অন্তর্ভুক্ত রয়েছে। HTTP স্ট্যাটাস 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 অপশনগুলো ব্যবহার করতে পারেন।

• আপনি যদি পোস্টম্যান ব্যবহার করেন, তাহলে আপনাকে সেভ অ্যান্ড ডাউনলোড বাটনটি সিলেক্ট করতে হবে। এক্ষেত্রে, response নামের একটি জিপ ফাইল ডাউনলোড হবে।

• আপনি ক্রোম ব্রাউজার ব্যবহার করলে ডাউনলোডটি স্বয়ংক্রিয়ভাবে গৃহীত হয়ে যায়।

অনুরোধটি সফল হলে এবং ফলাফলের মান শূন্য না হলে, ফলাফলটি একটি জিপ করা JSON (নিউলাইন দ্বারা বিভক্ত) ফাইল হিসেবে ক্লায়েন্টে ডাউনলোড করা হয়। ডাউনলোড করা ফাইলটির নাম হবে:

OfflineQueryResult-<query-id>.zip

উদাহরণস্বরূপ:

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

জিপ ফাইলটিতে JSON ফলাফলের একটি .gz আর্কাইভ ফাইল রয়েছে। JSON ফাইলটি অ্যাক্সেস করতে, ডাউনলোড করা ফাইলটি আনজিপ করুন, তারপর gzip কমান্ড ব্যবহার করে JSON ফাইলটি এক্সট্র্যাক্ট করুন:

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

অনুরোধের মূল অংশ সম্পর্কে

এই বিভাগে এমন প্রতিটি প্যারামিটার বর্ণনা করা হয়েছে যা আপনি একটি কোয়েরির JSON রিকোয়েস্ট বডিতে ব্যবহার করতে পারেন। আপনার কোয়েরিতে ব্যবহারযোগ্য মেট্রিক্স এবং ডাইমেনশন সম্পর্কে বিস্তারিত জানতে, অ্যানালিটিক্স রেফারেন্স দেখুন।

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

রিপোজিটরিতে থাকা ডেটার মেয়াদ শেষ না হওয়া পর্যন্ত আপনি ইউআরএল থেকে ফলাফল সংগ্রহ করতে পারবেন। সীমাবদ্ধতা এবং ডিফল্টসমূহ দেখুন।

উদাহরণ

উদাহরণ ১: বার্তা সংখ্যার যোগফল

গত ৬০ মিনিটের বার্তা সংখ্যার যোগফল জানতে অনুসন্ধান করুন।

প্রশ্ন

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 এ একটি POST রিকোয়েস্ট পাঠান।

ঐচ্ছিকভাবে, আপনি environment কোয়েরি প্যারামিটারটি পাস করে এনভায়রনমেন্ট নির্দিষ্ট করতে পারেন। যদি নির্দিষ্ট না করা হয়, তাহলে কোয়েরি প্যারামিটারটির ডিফল্ট মান ` prod । উদাহরণস্বরূপ:

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

অনুরোধের মূল অংশে নিম্নলিখিত অনুসন্ধানের মানদণ্ডগুলো উল্লেখ করুন।

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

উদাহরণস্বরূপ, নিম্নলিখিত অনুরোধটি নির্দিষ্ট এপিআই প্রোডাক্ট এবং ডেভেলপার আইডির জন্য ২০১৭ সালের জুন মাসের একটি অ্যাসিঙ্ক্রোনাস মনিটাইজেশন রিপোর্ট তৈরি করে। রিপোর্টের শুরুর তারিখ fromDate এবং toDate তারিখ (toDate) UTC/GMT ফরম্যাটে থাকে এবং এতে সময় অন্তর্ভুক্ত থাকতে পারে।

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