Control Plane API des Conversions API Gateway für mehrere Konten: Referenz

Kennzahlen zu Konto-Events nach Zeitrahmen abrufen

Ruft kontospezifische Event-Kennzahlen auf Pixel- und Event-Ebene ab, sofern der Admin Verwaltungszugriff auf das Konto hat.

Schema

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

Felder

Feld Beschreibung

Feld	Beschreibung
`tenantId` ID	Erforderlich Eindeutige ID des Kontos
`pixelIds` String	Optional Liste der Pixel-IDs, für die Event-Kennzahlen abgerufen werden müssen
`timeWindow` Int	Optional Zeitfenster in Minuten (Standardwert ist 60 Minuten)

tenantId
ID

Erforderlich

Eindeutige ID des Kontos

pixelIds
String

Optional

Liste der Pixel-IDs, für die Event-Kennzahlen abgerufen werden müssen

timeWindow
Int

Optional

Zeitfenster in Minuten (Standardwert ist 60 Minuten)

Rückgabe

EventMetricsSnapshot

Feld	Beschreibung
`id` ID	ID für EventMetricsSnapshot – immer EventTrafficSummary:incoming
`incoming` EventTrafficSummary	Übersichtsdaten zu eingehenden Events
`outgoing` ConversionsApiPublishSummary	Daten zu ausgehenden Events
`activity` EventActivity	Liste der Event-Aktivitäten
`domainActivity` DomainActivity	Liste der Domainaktivitäten

Fehlercodes

Code	Beschreibung
401	Zum Anzeigen von Event-Metriken nicht autorisiert
500	Interner Serverfehler

Beispielanfrage

Abfrage

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

Variablen

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

Beispielantwort

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