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

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশনে যান । তথ্য

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

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

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

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

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

UI এর সাথে প্রতিবেদনের API তুলনা করা

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

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

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

Apigee হাইব্রিড মধ্যে সীমা

Apigee হাইব্রিড ফলাফল ডেটা সেটে একটি 30 MB আকারের সীমা প্রয়োগ করে৷

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

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

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

2. ক্যোয়ারী স্ট্যাটাস পান ।

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

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

আপনাকে অবশ্যই /queries API এ একটি POST অনুরোধ পাঠাতে হবে। এই API এজকে পটভূমিতে আপনার অনুরোধ প্রক্রিয়া করতে বলে। যদি কোয়েরি জমা দেওয়া সফল হয়, তাহলে API একটি 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 প্রতিক্রিয়াতে অন্তর্ভুক্ত করা হয়েছে। 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",
}

ধাপ 2. ক্যোয়ারী স্ট্যাটাস পান

প্রশ্নের স্থিতির অনুরোধ করতে একটি 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"
}

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

ক্যোয়ারী স্ট্যাটাস completed হওয়ার পরে, আপনি ফলাফলগুলি পুনরুদ্ধার করতে get ফলাফল API ব্যবহার করতে পারেন, যেখানে ক্যোয়ারী আইডি আবার 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 নামক একটি জিপ ফাইল ডাউনলোড করা হয়।

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

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

OfflineQueryResult-<query-id>.zip

যেমন:

OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.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"}    
…

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

উদাহরণ

উদাহরণ 1: বার্তা গণনার যোগফল

বার্তার যোগফলের জন্য ক্যোয়ারী শেষ 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"
}

উদাহরণ 2: কাস্টম সময় পরিসীমা

একটি কাস্টম সময় পরিসীমা ব্যবহার করে ক্যোয়ারী।

প্রশ্ন

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

উদাহরণ 3: প্রতি মিনিটে লেনদেন

প্রতি মিনিটে লেনদেনের জন্য মেট্রিকে প্রশ্ন (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"}
...

উদাহরণ 4: ফিল্টার এক্সপ্রেশন ব্যবহার করা

একটি বুলিয়ান অপারেটর ব্যবহার করে এমন একটি ফিল্টার এক্সপ্রেশন সহ ক্যোয়ারী।

প্রশ্ন

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

উদাহরণ 5: মেট্রিক্স প্যারামিটারে এক্সপ্রেশন পাস করা

মেট্রিক্স প্যারামিটারের অংশ হিসাবে পাস করা একটি এক্সপ্রেশন সহ ক্যোয়ারী। আপনি শুধুমাত্র সাধারণ এক-অপারেটর এক্সপ্রেশন ব্যবহার করতে পারেন।

প্রশ্ন

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) কোয়েরির ফলাফল পুনরুদ্ধার করুন।

ধাপ 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"}
]

উদাহরণস্বরূপ, নিম্নলিখিত অনুরোধটি নির্দিষ্ট API পণ্য এবং বিকাশকারী আইডির জন্য জুন 2017 মাসের জন্য একটি অ্যাসিঙ্ক্রোনাস নগদীকরণ প্রতিবেদন তৈরি করে৷ fromDate 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