Cato API للقراءة فقط - appStats

نظرة عامة على appStats

تعتمد واجهة برمجة التطبيقات appStats على شاشة تحليلات التطبيق وتوفر بيانات شبكة مجمعة على مدى فترة زمنية حسب المصدر والوجهة والتطبيق وما إلى ذلك.

كل استعلام يحسب التجميع عبر مقاييس مختلفة (عدد البايتات المرفوعة، البايتات المحملة، عدد التدفقات، إلخ...) باستخدام دالة تجميع معينة (المجموع، الحد الأقصى، المتوسط، إلخ...) وأبعاد مختلفة (اسم الموقع، المستخدم، التطبيق، إلخ...)

أمثلة على استخدام استعلام appStats:

• حساب مجموع/متوسط/أقصى عرض نطاق لموقع محدد

• الحد الأقصى لعدد التدفقات المتولدة إلى وجهة معينة

• أفضل 10 تطبيقات مستخدمة بواسطة مضيف معين

المعطيات الخاصة بـ appStats

هذه هي الحجج التي يمكنك تمريرها وتحديد البيانات التي يتم إرجاعها بواسطة الاستعلام (جميع الحقول إلزامية):

• معرّفات الحسابات

• measures

• filters

• البعد

• sort

• الإطار الزمني

حجة معرّفات الحسابات لـ appStats

أدخل معرّف حساب واحد أو أكثر للبيانات التي يُرجعها الاستعلام.

لا يُظهر معرّف الحساب هذا في تطبيق إدارة Cato، إنما هو الرقم في عنوان URL لبوابة إدارة Cato. على سبيل المثال، معرف الحساب هو 26 لعنوان URL التالي: https://cc.catonetworks.com/#!/26/topology.

حجة عوامل التصفية لـ appStats

تسمح لك حجة عوامل التصفية بتحديد البيانات المحددة التي يتم تضمينها في الاستعلام. هذه هي المعطيات التي يمكنك تحديدها:

• اسم الحقل - يحدد نوع الحقل الذي تريد تصفيته (لمزيد من المعلومات، انظر أدناه حقول appStats)

• المشغل - يحدد كيفية تفعيل القيم لتصفية البيانات (لمزيد من المعلومات، انظر أدناه عامل التشغيل لـ appStats)

• values - يحدد قيمة الفلتر التي تستخدم مع العملية

الصيغة التالية لـ الفلاتر مثال لاستعلام يتم تصفيته لإظهار بيانات لتطبيق معين:

"filters": [
    {  
        "fieldName": "application",
        "operator": "is",
        "values": [   
            "Slack"
        ]
      }
]

حجة الأبعاد لـ appStats

استخدم الحجة dimensions لتجميع الحقول ذات القيم المتطابقة في صفوف ملخصة.

المثال التالي يجمع الحقول حسب أسماء المواقع:

"dimensions": [
    {
        "fieldName": "site_name"
    }
]

حجة المقاييس لـ appStats

تسمح لك حجة المقاييس بتحديد الحقول التي تريد أن يرجعها الاستعلام ونوع تجميعها. هذه هي الحجج التي يمكنك تحديدها:

• اسم الحقل - يحدد نوع الحقل الذي تريد تصفيته (لمزيد من المعلومات، انظر أدناه حقول appStats)

• نوع التجميع - يحدد نوع التجميع (لمزيد من المعلومات، انظر أدناه تجميع appStats)

يوضح المثال التالي صيغة المقاييس لاستعلام يقيس ملخص التدفقات التي تم إنشاؤها لتطبيق Slack:

"filters": [
    {  
        "fieldName": "application",
        "operator": "is",
        "values": [   
            "Slack"
        ]
      }
]
"measures": [
    {
        "fieldName": "flows_created",
        "aggType": "sum"
    },

]

حجة الترتيب لـ appStats

تحدد حجة الترتيب كيفية ترتيب البيانات.

يظهر المثال التالي صيغة الترتيب لاستعلام يقيس ملخص التدفقات التي تم إنشاؤها لتطبيق Slack. ثم يرتب البيانات بترتيب تنازلي حسب التدفقات التي تم إنشاؤها:

"filters": [
    {  
        "fieldName": "application",
        "operator": "is",
        "values": [   
            "Slack"
        ]
      }
]
"measures": [
    {
        "fieldName": "flows_created",
        "aggType": "sum"
    },

]
"sort": [
    {
        "fieldName": "flows_created",
        "order": "dec"
    },
]

حجة الإطار الزمني لـ appStats

يحدد إطار زمني timeframe للاستعلام.

"timeFrame": "last.P2D"

استعلام appStats نموذجي

هذا مثال لاستخدام واجهة برمجة تطبيقات الاستعلام appStats لإرجاع مجموع التدفقات التي تم إنشاؤها لتطبيق Slack لكل موقع على مدار فترة زمنية تمتد إلى اليومين الماضيين. يتم ترتيب البيانات بترتيب تنازلي لأفضل خمسة مواقع.

عينة استعلام

query appStats($accountID: ID!, $measures: [Measure], $dimensions: [Dimension], $filters: [AppStatsFilter!], $sort: [AppStatsSort!], $timeFrame: TimeFrame!, $limit: Int, $from: Int) {
  appStats(
    accountID: $accountID
    timeFrame: $timeFrame
    measures: $measures
    dimensions: $dimensions
    filters: $filters
    sort: $sort
  ) {
    id
    records(limit: $limit, from: $from) {
      fieldsUnitTypes
      fieldsMap
      trends
   
    }
  }
}

قيم المتغيرات

{
  "accountID": "1234",
  "dimensions": [
    {
      "fieldName": "site_name"
    }
  ],
  "measures": [
    {
      "fieldName": "flows_created",
      "aggType": "sum"
    },
  ],
"filters": [
    {  
        "fieldName": "application",
        "operator": "is",
        "values": [   
            "Slack"
        ]
      }
]
  "sort": [
    {
      "fieldName": "flows_created",
      "order": "desc"
    }
  ],
  "timeFrame": "last.P2D",
  "limit": 5,
  "from": 0
}

مخرج appStats نموذجي

{
   "data": {
     "appStats": {
       "id": "1234",
       "records": [
         {
           "fieldsMap": {
             "flows_created": "116660",
             "site_name": "Sample Socket"
           }
         },
         {
           "fieldsMap": {
             "flows_created": "105655",
             "site_name": " Sample Socket 2"
           }
         }
       ]
     }
   }
}

حقول appStats

هذا وصف للحقول في استعلامات appStats.

تجميع appStats

هذه هي القيم لـ appStats aggType:

• مجموع

• عدد

• عدد مميز

• مميز

• متوسط

• أقصى

• أدنى

• أي

عامل تصفية appStats

هذه هي القيم لعامل تصفية appStats:

• هو

• ليس هو

• في

• ليس في

• موجود

• غير موجود

• بين

• ليس بين

• أكبر من

• أكبر من أو يساوي

• أقل من

• أقل من أو يساوي