Cato للقراءة فقط API - الأحداث

هذا هو accountID للحساب الذي تقوم بتشغيل الاستعلام عليه.

تتيح لك الحجة measures تحديد الحقول التي تريد أن يفحصها استعلام events والطريقة التي يجب تجميع النتائج بها. لكل حقل تريد تحليله، يجب تحديد ما يلي: 

يوضح المثال التالي بناء جملة measures لاستعلام يعيد مجموع حقول event_count: 

 "measures": [
    {"fieldName":"event_count","aggType":"sum"}
]

تتيح لك الحجة filters تحديد فلتر يؤدي إلى فحص جزء محدود فقط من الأحداث. لكل فلتر يجب تحديد ما يلي:

إليك مثال على استخدام الحجة filters لاختيار فقط الأحداث التي نوعها أمني:

"filters": [
    {
        "fieldName": "event_type",        
        "operator": "is",
        "values": ["Security"]
    }
]

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

إليك مثال يجمع الملفات حسب نوع الحدث:

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

تحدد الحجة sort كيفية ترتيب البيانات المعادة.  إليك مثال على استخدام الحجة sort

  'sort': [
      {'fieldName': 'event_count', 'order': 'desc'},
      {'fieldName': 'event_type', 'order': 'asc'}
  ]

يحدد إطار زمني timeframe للاستعلام.  هذا محدد باستخدام التنسيق المحدد بواسطة المواصفة ISO 8601. إليك مثال على كيفية تحديد الإطار الزمني للأيام الثلاثين الماضية:

"timeFrame": "last.P30D" 

query events(
    $accountID: ID!,
    $measures: [EventsMeasure],
    $dimensions: [EventsDimension],
    $filters: [EventsFilter!],
    $sort: [EventsSort!],
    $timeFrame: TimeFrame!,
    $limit: Int,
    $from: Int) {  
    events(
        accountID: $accountID
        timeFrame: $timeFrame
        measures: $measures
        dimensions: $dimensions
        filters: $filters
        sort: $sort  ) {
        id    
        from
        total
        records(limit: $limit, from: $from) {
            fieldsMap
        }
    }
}

{  
    "accountID": "1234",
    "measures": [ {
          "fieldName": "event_sub_type",
          "aggType": "count_distinct"
          }
    ],
    "filters": [ {
          "fieldName": "event_type",
          "operator": "is", "values": ["Security"]
          }  
    ],  
    "timeFrame": "last.P1M"
}

{  
    "data": {
        "events": {
            "id": "xxx",
            "from": "2023-01-26T00:00:00Z",
            "to": "2023-02-27T00:00:00Z",
            "total": 1,
            "records": [        
                 { 
                     "fieldsMap": {          
                        "event_sub_type": "6"
                        }
                 }
             ]
        }
    }
}