API مستوى التحكم في بوابة واجهة API التحويلات للحسابات المتعددة: المرجع

الحصول على أدوات قياس أحداث الحساب حسب الإطار الزمني

الحصول على أدوات قياس أحداث محددة في الحساب على مستوى البيكسل والحدث، بشرط أن تتوفر لدى المسؤول صلاحية الوصول لإدارة الحساب.

المخطط

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
query HomeViewQuery($tenantId: ID!, $pixelIds: [String!], $timeWindow: Int) {
  tenantQueries(tenantId: $tenantId) {
    eventMetrics(pixelIds: $pixelIds, timeWindowMin: $timeWindow) {
      activity {
        name
        receivedCount
        publishedCount
        lastUpdated
      }
      incoming {
        eventNamesCount
        eventsCount
      }
      outgoing {
        eventNamesCount
        eventsCount
        publishSuccessRate
      }
    }
  }
}
_________________________________________________________________________________________________________
tenantId: ID!
_______________________________________________________________________________________________________
pixelIds: [String!]
_______________________________________________________________________________________________________      
timeWindow: Int
     

الحقول

الحقلالوصف

tenantId
ID (معرف)

مطلوب

المعرف الفريد للحساب

pixelIds
String (سلسلة)

اختياري

قائمة بمعرفات البيكسل التي يجب الحصول على أدوات قياس الأحداث الخاصة بها

timeWindow
Int (عدد صحيح)

اختياري

الفترة الزمنية بالدقائق (القيمة الافتراضية هي 60 دقيقة)


النتائج التي يتم إرجاعها

EventMetricsSnapshot

الحقلالوصف

id
ID (معرف)

معرف EventMetricsSnapshot -- دائمًا EventTrafficSummary:incoming

incoming
EventTrafficSummary

بيانات ملخص الأحداث الواردة

outgoing
ConversionsApiPublishSummary

بيانات الأحداث الصادرة

activity
EventActivity

قائمة نشاط الحدث

domainActivity
DomainActivity

قائمة نشاط النطاق


رموز الأخطاء

الرمزالوصف

401

غير مصرح بعرض أدوات قياس الأحداث

500

خطأ داخلي بالخادم


عينة من الطلب

الاستعلام

query HomeViewQuery($tenantId: ID!, $pixelIds: [String!], $timeWindow: Int) {
 tenantQueries(tenantId: $tenantId) {
   eventMetrics(pixelIds: $pixelIds, timeWindowMin: $timeWindow) {
     activity {
       name
       receivedCount
       publishedCount
       lastUpdated
     }
     incoming {
       eventNamesCount
       eventsCount
     }
     outgoing {
       eventNamesCount
       eventsCount
       publishSuccessRate
     }
   }
 }
}
     

المتغيرات

{
 "tenantId": "IaoreXfj",
 "pixelIds": ["18904456377094531"]
}
     

عينة من الاستجابة

{
   "data": {
       "tenantQueries": {
           "eventMetrics": {
               "activity": [
                   {
                       "name": "Purchase_PN_Mar22_Events",
                       "receivedCount": 4,
                       "publishedCount": 0,
                       "lastUpdated": "1678753252000"
                   }
               ],
               "incoming": {
                   "eventNamesCount": 1,
                   "eventsCount": 4
               },
               "outgoing": {
                   "eventNamesCount": 0,
                   "eventsCount": 0,
                   "publishSuccessRate": 0.0
               }
           }
       }
   }
}