API Plan de contrôle du gateway API Conversions pour plusieurs comptes : référence

Obtenir des indicateurs d’évènements de compte par plage

Recevez les indicateurs d’évènements spécifiques à un compte au niveau du pixel et de l’évènement, sous réserve que l’admin dispose des accès de gestion du compte.

Schéma

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

Champs

Champ Description

Champ	Description
`tenantId` ID	Obligatoire Identifiant unique du compte
`pixelIds` Chaîne	Facultatif Liste des ID de pixel pour lesquels vous souhaitez obtenir les indicateurs d’évènements
`timeWindow` Nombre entier	Facultatif Fenêtre de temps en minutes (valeur par défaut : 60 minutes)

tenantId
ID

Obligatoire

Identifiant unique du compte

pixelIds
Chaîne

Facultatif

Liste des ID de pixel pour lesquels vous souhaitez obtenir les indicateurs d’évènements

timeWindow
Nombre entier

Facultatif

Fenêtre de temps en minutes (valeur par défaut : 60 minutes)

Réponse

EventMetricsSnapshot

Champ	Description
`id` ID	Identifiant du champ EventMetricsSnapshot : toujours EventTrafficSummary:incoming
`incoming` EventTrafficSummary	Données récapitulatives des évènements entrants
`outgoing` ConversionsApiPublishSummary	Données des évènements sortants
`activity` EventActivity	Liste des activités des évènements
`domainActivity` DomainActivity	Liste des activités des domaines

Codes d’erreur

Code	Description
401	Non autorisé pour afficher les indicateurs d’évènements
500	Erreur interne du serveur

Exemple de requête

Requête

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

Variables

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

Exemple de réponse

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