# cPanel API 2 Functions - EmailTrack::stats

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function returns a cPanel account's mail statistics.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=EmailTrack&cpanel_jsonapi_func=stats
```

div
Note:

For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

//  Report email statistics for account.
$email_stats = $cpanel->api2(
    'EmailTrack', 'stats'
 );
```

div
Note:

For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Report email statistics for account.
my $email_stats = $cpliveapi->api2(
    'EmailTrack', 'stats',
);
```

div
Note:

For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
  - cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
    - For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username EmailTrack stats
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "stats",
    "data": [
      {
        "TOTALSIZE": "1150",
        "SUCCESSCOUNT": "2",
        "SENDCOUNT": "7",
        "DEFERCOUNT": "18",
        "FAILCOUNT": "5",
        "INPROGRESSCOUNT": "0",
        "DEFERFAILCOUNT": "23"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "EmailTrack"
  }
}
```

Note:
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
thead
tr
th
strong
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
TOTALSIZE
td
em
integer
td
The total size of the messages that the server sent, in bytes.
td
A positive integer that represents the size of the messages, measured in bytes.
td
code
1150
tr
td
code
SUCCESSCOUNT
td
em
integer
td
p
The number of successful deliveries.
p
A message with three recipients can successfully deliver up to three times.
td
A positive integer.
td
code
2
tr
td
code
SENDCOUNT
td
em
integer
td
The number of sent messages.
td
A positive integer.
td
code
7
tr
td
code
DEFERCOUNT
td
em
integer
td
The number of deferral events.
td
A positive integer.
td
code
18
tr
td
code
FAILCOUNT
td
em
integer
td
p
The number of delivery failures.
p
A message with three recipients can fail to deliver up to three times.
td
A positive integer.
td
code
5
tr
td
code
INPROGRESSCOUNT
td
em
integer
td
The number of currently in progress messages.
td
An integer value.
td
code
0
tr
td
code
DEFERFAILCOUNT
td
em
integer
td
The combined number of deferral and failure events.
td
A positive integer.
td
code
23
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function 
strong
only
 returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1