Como configurar o acompanhamento da análise

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Configure o Google Analytics ou seu próprio acompanhamento de análise personalizado, conforme descrito nas seções a seguir.

Como configurar o Google Analytics

Para configurar o Google Analytics, você precisa de uma conta do Google Analytics e acesso ao código de acompanhamento que será adicionado às páginas do portal e usado para acompanhar a atividade no seu site. Para ver mais informações, consulte a Ajuda do Google Analytics.

Para configurar o Google Analytics:

  1. Selecione Publicar > Portais e selecione seu portal.
  2. Selecione Configurações no menu suspenso da barra de navegação superior.
    Como alternativa, clique em Configurações na página de destino do portal.
  3. Clique na guia Scripts personalizados.
  4. Em Google Analytics, insira seu ID de acompanhamento do Google Analytics.
  5. Clique em Save.

Como configurar o acompanhamento de análise personalizado

Configure sua solução personalizada de acompanhamento de análises passando os detalhes do evento para a própria função. Sua função personalizada precisa ser definida como parte do portal.onAnalyticsEvent no namespace global (declarado na variável window).

Por exemplo, convém enviar os detalhes do evento para um serviço de análise diferente do Google Analytics:

<script>
window.portal = {};
window.portal.onAnalyticsEvent = (event) => {
  // log event to console
  console.log(event);
  // TODO: publish event to custom analytics service
}
</script>

Adicione seu script personalizado a cada página do portal na guia Scripts personalizados da página "Configurações". Para mais informações, consulte Como adicionar scripts personalizados.

O portal gera os seguintes tipos de eventos no mesmo formato usado pelo Google Analytics:

Tipo de evento Exemplo de formato Mais informações
Visitas à página 

{
  hitType: 'pageview',
  page: '/apis'
};
Visualizações de página
Clique em Executar no painel "Testar" no documento de referência da API 

{
  hitType: 'event',
  eventCategory: 'docsEvents',
  eventAction: 'apixExecute'
}
Avaliação de eventos