Configure Google analytics or your own custom analytics tracking, as described
in the following sections.
Configuring Google Analytics
Before you can configure Google Analytics, you'll need a Google Analytics
account and access to the tracking code that will be added to your portal
pages and used to track activity on your site. For more information, see
Google Analytics help.
To configure Google Analytics:
Cloud Console UI
In the Apigee in Cloud console, go to the Distribution > Portals page.
Under Google Analytics, enter your Google Analytics tracking ID.
Click Save.
Classic UI
Select Publish > Portals and select your portal.
Select Settings in the drop-down menu in the top navigation bar.
Alternatively, you can click Settings on the portal landing page.
Click the Custom Scripts tab.
Under Google Analytics, enter your Google Analytics tracking ID.
Click Save.
Configuring custom analytics tracking
Configure your own custom analytics tracking solution by passing event details to your own custom function. Your custom function must be defined as part of the portal.onAnalyticsEvent in the global namespace (declared on the window variable).
For example, you might want to send the event details to an analytics service other than Google Analytics:
<script>
window.portal = {};
window.portal.onAnalyticsEvent = (event) => {
// log event to console
console.log(event);
// TODO: publish event to custom analytics service
}
</script>
Add your custom script to each page in your portal on the Custom Scripts tab of the Settings page. For more information, see Adding custom scripts.
The portal generates the following types of events in the same format used by Google Analytics:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThis documentation applies to both Apigee and Apigee hybrid platforms.\u003c/p\u003e\n"],["\u003cp\u003eYou can configure Google Analytics by entering your tracking ID in the portal settings under the "Custom Scripts" tab.\u003c/p\u003e\n"],["\u003cp\u003eCustom analytics tracking can be configured by defining a function \u003ccode\u003eportal.onAnalyticsEvent\u003c/code\u003e in the global namespace to handle event data.\u003c/p\u003e\n"],["\u003cp\u003eThe portal generates events such as page visits and clicks on "Execute" in the API reference documentation, which can be tracked.\u003c/p\u003e\n"]]],[],null,["*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n\u003cbr /\u003e\n\nConfigure Google analytics or your own custom analytics tracking, as described\nin the following sections.\n\nConfiguring Google Analytics\n\nBefore you can configure Google Analytics, you'll need a Google Analytics\naccount and access to the tracking code that will be added to your portal\npages and used to track activity on your site. For more information, see\n[Google Analytics help](https://support.google.com/analytics).\n\nTo configure Google Analytics: \n\nCloud Console UI\n\n1. In the Apigee in Cloud console, go to the **Distribution \\\u003e Portals** page.\n\n [Go to Portals](https://console.cloud.google.com/apigee/portals)\n2. Click your portal.\n\n3. Click **Settings** in the navigation menu.\n\n4. Click the **Custom Scripts** tab.\n\n5. Under **Google Analytics**, enter your Google Analytics tracking ID.\n\n6. Click **Save**.\n\nClassic UI\n\n1. Select **Publish \\\u003e Portals** and select your portal.\n2. Select **Settings** in the drop-down menu in the top navigation bar. Alternatively, you can click **Settings** on the portal landing page.\n3. Click the **Custom Scripts** tab.\n4. Under **Google Analytics**, enter your Google Analytics tracking ID.\n5. Click **Save**.\n\nConfiguring custom analytics tracking\n\nConfigure your own custom analytics tracking solution by passing event details to your own custom function. Your custom function must be defined as part of the `portal.onAnalyticsEvent` in the global namespace (declared on the `window` variable).\n\nFor example, you might want to send the event details to an analytics service other than Google Analytics: \n\n \u003cscript\u003e\n window.portal = {};\n window.portal.onAnalyticsEvent = (event) =\u003e {\n // log event to console\n console.log(event);\n // TODO: publish event to custom analytics service\n }\n \u003c/script\u003e\n\nAdd your custom script to each page in your portal on the **Custom Scripts** tab of the Settings page. For more information, see [Adding custom scripts](/apigee/docs/api-platform/publish/portal/custom-scripts).\n\nThe portal generates the following types of events in the same format used by Google Analytics:\n\n| Event type | Example format | More information |\n|--------------------------------------------------------------------|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|\n| Page visits | { hitType: 'pageview', page: '/apis' }; | [Page Views](https://developers.google.com/analytics/devguides/collection/analyticsjs/pages) |\n| Clicks on **Execute** on the Try it panel in the API reference doc | { hitType: 'event', eventCategory: 'docsEvents', eventAction: 'apixExecute' } | [Event Measurement](https://developers.google.com/analytics/devguides/collection/analyticsjs/events) |"]]
