API do Plano de Controle do Conversions API Gateway para várias contas: referência

Obtenha métricas de eventos da conta por intervalo de tempo

Obtém métricas de eventos específicos da conta em nível de Pixel e evento, contanto que o administrador tenha acesso para gerenciar a conta.

Esquema

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

Campos

Campo Descrição

Campo	Descrição
`tenantId` ID	Obrigatório Identificador único da conta
`pixelIds` String	Opcional Lista de identificações de Pixel para as quais as métricas de evento precisam ser obtidas
`timeWindow` Int	Opcional Janela de tempo em minutos (o valor padrão é de 60 minutos)

tenantId
ID

Obrigatório

Identificador único da conta

pixelIds
String

Opcional

Lista de identificações de Pixel para as quais as métricas de evento precisam ser obtidas

timeWindow
Int

Opcional

Janela de tempo em minutos (o valor padrão é de 60 minutos)

Retorna

EventMetricsSnapshot

Campo	Descrição
`id` ID	Identificador de EventMetricsSnapshot, sempre EventTrafficSummary:incoming
`incoming` EventTrafficSummary	Dados de resumo de eventos recebidos
`outgoing` ConversionsApiPublishSummary	Dados de eventos de saída
`activity` EventActivity	Lista de atividades de eventos
`domainActivity` DomainActivity	Lista de atividades de domínio

Códigos de erro

Código	Descrição
401	Sem autorização para ver as métricas do evento
500	Erro de servidor interno

Exemplo de solicitação

Consulta

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

Variáveis

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

Exemplo de resposta

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