How to Allow Users to Manage Interface Analytics

Last modified: 2025 August 28


Overview

This document describes how to use the /var/cpanel/panel.ini file to allow cPanel users to manage Interface Analytics.

Note:
  • The process in this document is only valid for cPanel & WHM version 130 and later.
  • If cPanel cannot retrieve a user’s analytics configuration, it will automatically allow users to manage their Interface Analytics.

Interface Analytics allows WebPros International, LLC to collect data about how users navigate cPanel, WHM, and Webmail from within the interface.

Effects of enabling user management

The table provides a detailed comparison of cPanel & WHM interface and function availability based on whether users can manage Interface Analytics:

Component Users can manage Interface Analytics Users cannot manage Interface Analytics
WHM’s Configure cPanel Analytics interface (WHM » Home » Server Configuration » Configure cPanel Analytics) a checkmark icon a X icon
The cPanel Account Preferences interface’s Consent and Privacy section (cPanel » Home » Preferences » Account Preferences) a checkmark icon a X icon
The Webmail interface’s Consent and Privacy form a checkmark icon a X icon
WHM’s participate_in_analytics function Affects Interface Analytics. Does not affect Interface Analytics.

If users can manage Interface Analytics, the server owner and individual users must enable the plugin before it begins to collect data.

These selections are made at the server and account levels as follows:

Server level Account level Interface Analytics
Yes Yes Enabled
Yes No Disabled
No Yes Disabled
No No Disabled

For more information about cPanel Analytics, read our cPanel Analytics documentation.

Allow users to manage Interface Analytics

To allow users to manage Interface Analytics, perform the following steps:

  1. Navigate to WHM’s Terminal interface (WHM » Home » Server Configuration » Terminal).
  2. Open the /var/cpanel/panel.ini file with your preferred text editor.
  3. Set the analytics_consent.enable setting’s value to true.
  4. Save your changes and close the file.

Once users can manage Interface Analytics, they will be able to see Interface Analytics interface options, and must enable Interface Analytics on both the server and account level for it to collect data.

Check whether users can manage Interface Analytics

The analytics_consent.enable setting tells you whether users can manage Interface Analytics. If the value is true, users can manage Interface Analytics. If it is false, they cannot. You check whether users can access Interface Analytics interface options with one of the following methods:

  • Open the /var/cpanel/panel.ini file and review the analytics_consent.enable setting’s value.
  • Use UAPI’s leika_get_config API.
  • Use WHM API 1’s leika_get_config API.

Additional Documentation