cPanel API 2 Functions - Logaholic::processstats

Description

This function processes statistics for a Logaholic user's profile.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

 

Important:

As of cPanel & WHM version 11.48, the integrated Logaholic application is no longer available. We removed Logaholic's API functions, and they will not produce any results.

 

Examples 


 WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Logaholic&cpanel_jsonapi_func=processstats&username=example&profile=fish.example.com

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
//  Process statistics for the "newprofile" profile owned by Logaholic user "example"
$process_stats $cpanel->api2(
    'Logaholic''processstats',
    array(
        'username'       => 'example',
        'profile'        => 'subdomain.example.com',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Process statistics for the "newprofile" profile owned by Logaholic user "example"
my $process_stats $cpliveapi->api2(
    'Logaholic''processstats',
    {
        'username'      => 'example',
        'profile'       => 'subdomain.example.com',
    }
);

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

 Command Line

Important:

Because we removed this function before we introduced this functionality, you cannot call this function via the command line. 


 Output (JSON)

{
  "cpanelresult": {
    "apiversion"2,
    "func""processstats",
    "data": [
      {
        "reason""Profile data for Logaholic user "example" was processed.",
        "result"1,
        "profiles": {
          "profile": [
            {
              "details""The Logaholic profile for site "subdomain.example.com" was processed.",
              "profile_name""subdomain.example.com",
              "result"1
            }
          ]
        }
      }
    ],
    "event": {
      "result"1
    },
    "module""Logaholic"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

Return

Type

Description

 Possible values 

Example

 username 

 string

 Required

 The Logaholic username. 

 A valid string.

 example

 profile

 string 

 Required

 The Logaholic profile's name. 

 A valid string.

 subdomain.example.com 

 

Returns

Return

Type

Description

Possible values

Example

 reason

 string

 The status message from the function.

  • Profile data for Logaholic user "example" was processed.

 

 result

 boolean 

 Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.

 1

 profiles

 hash

 A hash that contains information about the profiles.

 This hash includes the profile hash for each user profile.

 

 profile

 hash

 A hash that contains information about an individual profile. 

 The function returns this hash in theprofiles hash.

 This hash includes thedetails, profile_name, and result parameters. 

 

 details

 string

 Logaholic's response message.

 The function returns this parameter in theprofile hash.

 A message of success or reason for failure.

 

 profile_name 

 string

 The name of the Logaholic user's profile.

 The function returns this parameter in theprofile hash.

 A valid string.

 subdomain.example.com 

 result

 integer

 Whether the function succeeded.

 The function returns this parameter in theprofile hash.

  • 1 — The function succeeded.
  • 0 — The function failed.

 1

 

  • 6 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....