Page tree
Skip to end of metadata
Go to start of metadata

Important:

We released the first version of cPanel Analytics' Interface Analytics plugin in cPanel & WHM version 74. We will release the full system in cPanel & WHM version 78.

Overview

The optional cPanel Analytics features collect data about how users use cPanel & WHM's interfaces and how hosting providers configure servers. We plan to use this information to improve the user experience in our products. 

We take your privacy very seriously and have taken precautions to ensure that the data we collect is voluntary and secure. We retain cPanel Analytics data for 26 months and then destroy it.

Important:

  • cPanel Analytics features are optional. We do not collect any data until the root user enables them at the server level. Additionally, Interface Analytics does not collect data about specific accounts' use until that user enables data collection at the account level.
  • You can enable or disable cPanel Analytics features at the account or server level at any time.
  • Interface Analytics respects the dnt (Do Not Track) header. If you have disabled tracking in your browser, the feature will not collect data about you.

Interface Analytics

Interface Analytics allows us to collect data about how users navigate cPanel, WHM, and Webmail from within the interface. In cPanel & WHM version 78 and later, we automatically install the Interface Analytics plugin by default but do not enable it. The server owner must still enable the plugin and individual users must enable it for their accounts before data collection will begin.

Remember:

cPanel Analytics is optional. We do not collect any data until the root user enables the plugin at the server level. Additionally, we do not collect data about specific accounts' use until that user enables data collection at the account level.

When you enable Interface Analytics at the server level and users enable it at the account level, the plugin gathers the following information about users' actions within cPanel & WHM:

  • The server's cPanel & WHM product version.
  • The operating system (OS) and OS version.
  • Whether an account is a cPanel, WHM, or Webmail account.
  • The company ID as it exists in Manage2's Update Company Information interface (Manage2 >> Company >> Update Company Information) or in the /var/cpanel/companyid file.

    Note:

    Interface Analytics gathers the Company ID as part of our partnership with individual customers. Our Account Management, Customer Service, and Marketing teams may analyze this data when they prepare reports. For more information, contact our Account Management team.


  • cPanel or Webmail accounts' interface style and theme.
  • The frequency with which cPanel, WHM, and Webmail users access their accounts and the type of devices that they used.
  • The use rates for specific features and cPanel-provided locales and data about how users interact with them.

Enable or disable cPanel Analytics features

Note:

We do not track the content that exists on cPanel accounts. Additionally, the system removes URL-query parameters before cPanel, L.L.C. receives the data.


Enable or disable cPanel Analytics features

With the exception of Interface Analytics, you can enable or disable cPanel Analytics features via settings in the Support section of WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).

Enable or disable Interface Analytics at the server level

Important:

You must manually install and enable cPanel Analytics' Interface Analytics plugin at the server level. Then, individual users can enable it at the account-level to begin data collection for that account.

To enable Interface Analytics at the server-level, run the following command as the root user to install the cpanel-analytics plugin:

yum install cpanel-analytics

When the /usr/local/cpanel/scripts/maintenance script runs, it checks for the /etc/yum.repos.d/cpanel-plugins.repo repository and creates the repository if it does not exist. This repository contains the cPanel Analytics Interface Analytics plugin as well as other cPanel-provided plugins.

Enable or disable Interface Analytics at the account level

After systems administrators install the cpanel-analytics plugin, a lightbulb () icon will appear on the right side of the cPanel, WHM, and Webmail interfaces.

Note:

This icon will also appear on the right side of each interface in cPanel & WHM and in Webmail.

To enable or disable Interface Analytics for the currently-authenticated account, perform the following steps:

  1. Click the lightbulb icon.
  2. Select the desired cPanel Analytics setting:
    • Select Allow to enable data collection.
    • Select Deny to disable data collection.

Additional documentation

There is no content with the specified labels