We strongly recommend that before you start using the Cato API, please review the Support Policy for the Cato API.

Overview of accountMetrics

The accountMetrics query helps you analyze the state and quality of the connections of sites and SDP users to the Cato Cloud. This data is for the traffic inside the DTLS tunnel between the site and the Cato Cloud.

accountMetrics shows historical metrics, statics, and analytics for the account. It returns data that is similar to the Site Connectivity window in the Cato Management Application.

For reseller accounts, you can create separate API keys inside each customer account that you are connecting to the Cato API. For more about rate limiting and the accountMetrics API query, see Understanding Cato API Rate Limiting.

Working with Bucket Granularity and API Query Limits

There is a maximum limit of 100,000 returned items per accountMetrics API query. If a query reaches this limit, then the query doesn't return any additional data and an error message is displayed.

Cato calculates this limit based on multiplying the following elements:

• Total number of sites plus VPN users
• Number of metrics (API labels/telemetry)
• Number of buckets

In other words, the sum of (sites + VPN users) * (metrics) * (buckets) must be less than 100,000. For example, the following query will produce an error:

• 10 sites
• 140 VPN users
• 5 metrics
• 150 buckets

(10 + 140) * 5 * 150 = 112,500 items in the query. In this example, you can reduce the number of buckets to successfully run the query.

For more about the types of API labels, see Cato API - AccountMetrics > Timeseries.

Calculating the Minimum Granularity for a Query

This section explains how to calculate the minimum granularity (bucket size) based on the time frame for the query.

1. Timeframe - Convert the time frame to seconds
2. Bucket limit - Calculate the bucket limit based on 100000 / ( (sites + VPN users) * (metrics) )
3. Minimum Granularity = (timeframe) / (bucket limit)

For example, the first row in the table below shows the query limit for 7 days, 100 sites and VPN users, with 5 metrics:

• 7 days = 604,800 seconds
• 200 buckets = 10000 / (100) * (5)
• 3024 seconds minimum granularity = 604800 / 200

The following table shows sample settings for the accountMetrics query with the minimum bucket granularity:

accountMetrics ক্ষেত্রসমূহের বিস্তারিত

Query-এর জন্য accountMetrics ক্ষেত্রগুলির দ্বারা ফেরত দেওয়া যেতে পারে এমন বিস্তারিত বিবরণঃ

• আইডি - অ্যাকাউন্ট ID
• থেকে - শুরুর সময়
• প্রতি - শেষ সময়
• granularity - বালতির আকার
• সাইটসমূহ - প্রতিটি সাইটের জন্য ফেরত দেওয়া হয় ডেটা (সন্নিবেশিত কোয়েরি এবং ক্ষেত্রগুলির সাথে অ্যারে)
• সময়সীমা - ডেটার জন্য সময়ের সীমা, এবং বালতি এবং ডেটার মধ্যে সম্পর্ক সংজ্ঞায়িত করে (সন্নিবেশিত কোয়েরি এবং ক্ষেত্রগুলির সাথে অ্যারে)

accountMetrics ID

আইডি ক্ষেত্রটি অনন্য অ্যাকাউন্ট অভ্যন্তরীণ আইডি প্রদর্শন করে।

এই অ্যাকাউন্ট আইডি Cato ম্যানেজমেন্ট অ্যাপ্লিকেশনে প্রদর্শিত হয় না, এটি পরিবর্তে Cato ম্যানেজমেন্ট অ্যাপ্লিকেশনের ইউআরএলে সংখ্যা হিসাবে থাকে। উদাহরণস্বরূপ, নিম্নলিখিত ইউআরএলে অ্যাকাউন্ট আইডি হল ২৬: https://cc2.catonetworks.com/#!/26/topology।

accountMetrics থেকে

থেকে ক্ষেত্রটি কোয়েরি ডেটার জন্য শুরুর সময় প্রদর্শন করে এবং এটি সময়কাল আর্গুমেন্টে সংজ্ঞায়িত হয়।

accountMetrics প্রতি

প্রতি ক্ষেত্রটি কোয়েরি ডেটার জন্য শেষ সময় প্রদর্শন করে এবং এটি সময়কাল আর্গুমেন্টে সংজ্ঞায়িত হয়।

accountMetrics granularity

Granularity ক্ষেত্রটি একটি অবিচ্ছিন্ন মেট্রিক বালতির জন্য সময়কাল সেকেন্ডে দেখায়। বালতি সংখ্যার সময়সীমা > বালতি আর্গুমেন্টে নির্ধারিত হয়।

গ্রানুলারিটি নিম্নলিখিত সূত্র অনুযায়ী গণনা করা হয়: সময়কাল/বালতি। উদাহরণস্বরূপ, যদি কোয়েরি ৬০ বালতি সহ পাঁচ মিনিটের ডেটা (সময়কাল) ফেরত দেওয়ার হয়, তবে গ্রানুলারিটি (বালতির আকার) ৫ সেকেন্ড (৩০০ সেকেন্ড / ৬০) হয়।

একটি বালতির জন্য সর্বনিম্ন গ্রানুলারিটি হল ৫ সেকেন্ড। যখন বালতির গ্রানুলারিটি ৫ সেকেন্ডের কম হয়, তখন এটি সম্ভাবনা থাকে যে সেই বালতির জন্য কোন ডেটা ফেরত দেওয়া হয় না।

Granularity ক্ষেত্র সম্পর্কে আরও জানতে দেখুন accountMetrics > Granularity নিয়ে কাজ করা।

accountMetrics সাইটসমূহ

সাইটসমূহ ক্ষেত্রটি অ্যাকাউন্টের মধ্যে একটি বা একাধিক সাইটের সাথে সম্পর্কিত ডেটা অন্তর্ভুক্ত করে। আপনি VPN ব্যবহারকারীদের ব্যবহারকারী ID এর সাথে ডেটাও নির্দিষ্ট করতে পারেন।

accountMetrics-এর জন্য সাইটসমূহ ক্ষেত্রে সম্পর্কে আরও জানতে দেখুন Cato API - AccountMetrics > সাইটসমূহ।

accountMetrics সময়সীমা

যথা, কোয়েরিতে উল্লিখিত সময়সীমা (বালতি) অনুযায়ী অ্যাকাউন্টে মেট্রিক প্রদর্শন করে, এবং ঐতিহাসিক পরিসংখ্যান ও মেট্রিক অন্তর্ভুক্ত করে। এই ডেটা Cato ম্যানেজমেন্ট অ্যাপ্লিকেশনে প্রতিটি সাইটের জন্য সাইট সংযোগ উইন্ডোতে ক্ষেত্রের মতো।

accountMetrics-এর সময়সীমার ক্ষেত্র সম্পর্কে আরও জানতে দেখুন Cato API - AccountMetrics > Time-series।

accountMetrics-এর আর্গুমেন্টসমূহ

এগুলি হল আর্গুমেন্টগুলি যা আপনি পাস করতে পারেন এবং প্রশ্ন ফেরত দেয় এমন ডাটা সংজ্ঞায়িত করতে পারেন।

• অ্যাকাউন্ট আইডি - অ্যাকাউন্ট আইডি
• আইডি - অ্যাকাউন্ট আইডি (লিগেসি আর্গুমেন্ট)
• সময়কাল - কুয়েরী শুরু এবং সমাপ্তি সময়
• গ্রুপ ইন্টারফেসগুলো - লিঙ্কটির জন্য বিশ্লেষণকে একটি লিঙ্কে মিলিত করুন (বুলিয়ান মান true জন্য)
• গ্রুপ ডিভাইসগুলি - একাধিক সাইটগুলির জন্য, এবং অনেক সকেট সহ একটি একক সাইটের জন্য, বিশ্লেষণগুলি একটি একক সকেটে মিলিত করুন (বুলিয়ান মান true জন্য)

অ্যাকাউন্ট মেট্রিক্স অ্যাকাউন্ট আইডি আর্গুমেন্ট

কুয়েরি যে ডাটা ফেরত দেয়, তার জন্য অ্যাকাউন্ট আইডি লিখুন। এই আর্গুমেন্টটি বাধ্যতামূলক।

এই অ্যাকাউন্ট আইডিটি Cato ম্যানেজমেন্ট অ্যাপ্লিকেশনে প্রদর্শিত হয় না, বরং এটি Cato ম্যানেজমেন্ট অ্যাপ্লিকেশনের ইউআরএল এ থাকা নম্বর। উদাহরণস্বরূপ, নিম্নলিখিত ইউআরএল এর জন্য অ্যাকাউন্ট আইডি হল 26: https://cc2.catonetworks.com/#!/26/topology।

অ্যাকাউন্ট মেট্রিক্স সময়কাল আর্গুমেন্ট

কুয়েরী যে ডাটা ফেরত দেয় তার জন্য সময়কাল লিখুন। আর্গুমেন্টটি <ধরন>.<সময় মান> ফর্ম্যাটে থাকে। এই আর্গুমেন্টটি বাধ্যতামূলক।

সময়কাল নির্ধারণ করতে সমর্থিত অপশনগুলি হল:

• শেষ.<সময়কাল> - শেষ প্রকারের জন্য <সময়কাল> মান ISO-8601 অনুযায়ী পূর্ববর্তী নির্দিষ্ট সময়ের জন্য ডাটা ফেরত দেয়। উদাহরণস্বরূপ:
  • সময়কাল = শেষ.PT5M পূর্ববর্তী ৫ মিনিট প্রদর্শন করে।
  • সময়কাল = শেষ.PT2H পূর্ববর্তী ২ ঘন্টা প্রদর্শন করে।
  • সময়কাল = শেষ.P1D পূর্ববর্তী ১ দিন প্রদর্শন করে।
  • সময়কাল = শেষ.P3M পূর্ববর্তী ৩ মাস প্রদর্শন করে।
  • সময়কাল = শেষ.P1Y পূর্ববর্তী ১ বছর প্রদর্শন করে।
• utc.<সংক্ষিপ্ত-সময়-ফ্রেম-বিস্তারিত> - সময় ফ্রেম নির্দিষ্ট সময় অঞ্চল অনুযায়ী YY-MM-DD/hh:mm:ss ফর্ম্যাটে শুরু এবং শেষ তারিখের সংযোগ করে। আর্গুমেন্টের জন্য আপনাকে সমস্ত তারিখ এবং সময়ের মান লিখতে হবে। উদাহরণস্বরূপ:
  • সময়কাল = utc.2020-02-{11/04:50:00--21/04:50:00} ১১ ফেব্রুয়ারি, ২০২০ ৪:৫০:০০ am থেকে ২১ ফেব্রুয়ারি, ২০২০ ৪:৫০:০০ am পর্যন্ত ১০ দিনের বিশ্লেষণ ডাটা প্রদর্শন করে।
  • সময়কাল = utc.2020-02-11/{04:50:15--16:50:15} ১১ ফেব্রুয়ারি, ২০২০ এর ৪:৫০:১৫ am থেকে ১৬:৫০:১৫ pm পর্যন্ত ১২ ঘন্টার বিশ্লেষণ ডাটা প্রদর্শন করে।
  • সময়কাল = utc.2020-{02-11/04:50:00--04-11/04:50:00} ১১ ফেব্রুয়ারি ২০২০ ৪:৫০:০০ am থেকে ১১ এপ্রিল ৪:৫০:০০ am পর্যন্ত ২ মাসের বিশ্লেষণ ডাটা প্রদর্শন করে।
  • সময়কাল = utc.{2019-10-01/04:50:00--2020-02-01/04:50:00} ১ অক্টোবর, ২০১৯ ৪:৫০:০০ am থেকে ১১ ফেব্রুয়ারি, ২০২০ ৪:৫০:০০ am পর্যন্ত ৪ মাসের বিশ্লেষণ ডাটা প্রদর্শন করে।

    এই ফরম্যাটটি আপনাকে একাধিক ক্যালেন্ডার বছরের অন্তর্ভুক্ত করতে একটি সময়কাল কনফিগার করতে দেয়।

timeFrame আর্গুমেন্ট এবং Granularity ক্ষেত্র সম্পর্কে আরও জানতে, accountMetrics > Granularity সাথে কাজ করা দেখুন।

accountMetrics groupInterfaces আর্গুমেন্ট

যখন boolean আর্গুমেন্ট groupInterfaces true এ সেট করা হয়, তখন সকল ইন্টারফেসের ডেটা একটি একক ইন্টারফেসে একত্রিত হয়।

accountMetrics groupDevices আর্গুমেন্ট

যখন boolean আর্গুমেন্ট groupDevices true এ সেট করা হয়, তখন সকল সকেটের জন্য বিশ্লেষণ (সাধারণত উচ্চ প্রাপ্যতায় দুটি) একটি ফলে একত্রিত হয়। সমগ্রিত সকেটের জন্য সর্বোত্তম ফলাফলের জন্য, আমরা উভয় সকেটের লিঙ্কগুলির জন্য সামঞ্জস্যপূর্ণ নাম এবং কার্যকারিতা (উদাহরণস্বরূপ গন্তব্যস্থান) থাকার সুপারিশ করি।