Child pages
  • WHM API 1 Functions - participate_in_analytics
Skip to end of metadata
Go to start of metadata

Description

This function enables or disables cPanel Analytics.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/participate_in_analytics?api.version=1&enabled=1
 Command Line
whmapi1 participate_in_analytics enabled=1


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "participate_in_analytics"
  }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
enabledBoolean

Required

Whether to enable cPanel Analytics.

  • 1 — Enable.
  • 0 — Disable.
 1

Returns

This function only returns metadata.